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 You do not need to be \textbf{root} (or \textit{sudo} ...) to install, except to run \texttt{bld\_prepare.sh} which calls in the distro's package manager. However if there are problems with permissions you can try to compile as root.
226 \item The \textit{git:} step has to download many files (approx
227 130\,MB) so allow time. When decompressed this will expand to
230 \item Run the following commands (this takes awhile):
232 \begin{lstlisting}[style=sh]
233 # This is where you need the 6.0GB of disk space:
235 git clone --depth 1 "git://git.cinelerra-gg.org/goodguy/cinelerra.git" cinelerra5
236 # Change to the cloned directory:
237 cd cinelerra5/cinelerra-5.1
239 NOTE: if your system has never had \CGG{} Infinity installed, you
240 will have to make sure you have all of the compilers and libraries
241 necessary. So on the very first build you should run:
243 \begin{lstlisting}[style=sh]
244 ./blds/bld_prepare.sh <os> # where <os> represents the
245 # Operating System of
246 # centos, fedora, suse, ubuntu, mint, debian, arch, debian-testing, ubuntu-testing.
248 ./configure --prefix=/usr # optional parameters can be added here
249 make 2>&1 | tee log # make and log the build
252 \texttt{bld\_prepare.sh} works for debian-testing, ubuntu-testing, and arch with some additional information. For Arch linux, a README file containing many more dependencies is maintained. For Gentoo, a README file lists other dependencies that have to be installed manually.
254 \item \href{https://cinelerra-gg.org/download/README.arch}{https://cinelerra-gg.org/download/README.arch}
255 \item \href{https://cinelerra-gg.org/download/README.gentoo}{https://cinelerra-gg.org/download/README.gentoo}
258 \texttt{bld\_prepare.sh} option of debian-testing and ubuntu-testing is currently for perhaps the absolute latest versions and future distros and
259 will be changed to more relevant names when they are released.
261 \item Check for obvious build errors:
262 \begin{lstlisting}[style=sh]
263 grep "\*\*\*.*error" -ai log
265 If this reports errors and you need assistance or you think
266 improvements can be made to the builds, email the log which is
268 \href{mailto:cin@lists.cinelerra-gg.org}{cin@lists.cinelerra-gg.org}
269 \begin{lstlisting}[style=sh]
270 /<build_path>/cinelerra5/cinelerra-5.1/log
273 \item If there are no build errors, finally just run:
274 \begin{lstlisting}[style=sh]
277 Where <os> represents the Operating System supported by \CGG{}, such
278 as centos, fedora, suse, ubuntu, mint, or debian.
279 The ``with-single-user'' parameter makes it so.
280 % Make and log build (
281 Check for errors before proceeding.
284 \item If it all worked, you are all setup. Just click on the \CGG{}
289 \subsection{The single-user build}
290 \label{sec:single-user-build}
291 \index{single-user build}
294 To do a single-user build, read the file \texttt{README} that is at
295 the top level after you get the source.
298 \item You need at least 6\,GB of disk storage to operate a build +
299 you need to have “\texttt{git}” installed.
301 \item You can install it without being \textbf{root} or without using \textit{sudo}. In case of problems you can use \textit{sudo} to avoid permission issues.
302 \item The \textit{git} step has to download many files (approx
303 130\,MB) so allow time.
305 \item Run the following commands (this takes awhile):
306 \begin{lstlisting}[style=sh]
307 # This is where you need the 6GB of disk space
309 git clone --depth 1 "git://git.cinelerra-gg.org/goodguy/cinelerra.git" cinelerra5
310 # Toplevel directory:
311 cd cinelerra5/cinelerra-5.1
315 NOTE: if your system has never had \CGG{} Infinity installed, you
316 will have to make sure all the compilers and libraries necessary are
317 installed. Thus, for the execution part of \texttt{bld\_prepare.sh} you must use sudo, but the other steps can be done as a normal user.
319 % FIXME No novels in the listings.
320 \begin{lstlisting}[style=sh]
321 ./blds/bld_prepare.sh <os>
323 ./configure --with-single-user
327 Where <os> represents the Operating System supported by \CGG{}, such
328 as centos, fedora, suse, ubuntu, mint, debian and arch.
329 The ``with-single-user'' parameter makes it so.
330 % Make and log build (
331 Check for errors before proceeding.
334 Then just start the application by keying in: \texttt{./cin} in the
335 bin subdirectory OR add a desktop icon by using the appropriate
336 directory to copy the files to and edit to
337 correct the directory path. Below are generic directions of how to
340 Then just start the application by keying in: \texttt{./cin} in the
341 bin subdirectory OR add a desktop icon by using the appropriate
342 directory to copy the files to, run as root, and edit to correct the directory path. Below are generic directions of how to
345 \begin{lstlisting}[style=sh]
346 cd /cinelerra_directory_path
347 cp -a image/cin.{svg,xpm} /usr/share/pixmaps/
348 cp -a image/cin.desktop /usr/share/applications/cin.desktop
351 After you have followed the above, in the cin.desktop file, change
352 the \texttt{Exec=cin} line to be
353 \texttt{Exec=<your\_directory\_path>/bin/cin}.
355 A working example of how to build in Arch as a normal user:
357 \begin{lstlisting}[style=sh]
358 $ git clone --depth 1 "git://git.cinelerra-gg.org/goodguy/cinelerra.git" cinelerra5
359 $ cd /home/USER/cinelerra5/cinelerra-5.1
361 $ ./configure --with-single-user --with-booby
362 $ make 2>&1 | tee /tmp/cin5.log && make install
366 \subsection{Notable Options and Caveats}%
367 \label{sub:notable_options_and_caveats}
370 These procedures and the \CGG{} Infinity software have all been run
371 as \textbf{root} on various home laptops and desktops. This provides
372 the best chance to ensure all works correctly and also allows for
373 handling errors, other problems and potential crashes with the most
374 success. Included in this section are some of the build variations
375 easily available for normal builds.
377 To see the full list of features use:
379 \begin{lstlisting}[style=sh]
382 The default build \index{build} is a system build which uses:
384 \begin{lstlisting}[style=sh]
385 ./configure --without-single-user
388 In the single-user build \index{single-user build}, the target directory is always
389 \texttt{cin}. Because this is also the developer build, constant
390 names are used throughout. However, you can rename files after the
393 If your operating system has issues with the default install to
394 \texttt{/usr/local}, you might have to change the location to
395 \texttt{/usr} for a system build. Then you will have to use:
396 \begin{lstlisting}[style=sh]
397 ./configure --prefix=/usr
400 If you wish to change the default directory for a system build you
401 will have to add the destination directory path on the \texttt{make
402 install} line. For example:
403 \begin{lstlisting}[style=sh]
404 make install DESTDIR=<your selected target directory path>
407 The application name can be set during installation, but defaults to
408 \texttt{cin} so that the GG/Infinity build can coexist with other
409 \CGG{} builds if necessary. To override the default \texttt{cin}
411 \begin{lstlisting}[style=sh]
412 ./configure --with-exec-name=cinelerra
415 The home configuration directory can also be set, but default
416 location is traditionally \texttt{\$HOME/.bcast5}. For example:
418 \begin{lstlisting}[style=sh]
419 ./configure -with-config-dir=/myusername/.bcast5
422 NOTE: when you specify parameters to the configure program, it will
423 create a \texttt{make} file as a consequence. Since in a
424 \texttt{make} file, the \$ is a special character, it must be
425 escaped so in order to represent a \$ as part of an input parameter,
426 it has to be stuttered. That is, you will need \$\$ (2 dollar
427 signs) to represent a single dollar sign.
429 It may be necessary on some distros which have missing or incomplete
430 up-to-date libraries, to build \CGG{} without Ladspa. To do so,
433 \begin{lstlisting}[style=sh]
434 ./configure --prefix=/usr --without-ladspa-build
437 Note that the with-ladspa-dir is the ladspa search path, and
438 exists even if the ladspa build is not selected. This gives you
439 the ability to specify an alternate ladspa system path by
440 utilizing the \texttt{LADSPA\_PATH} environment variable (that is,
441 the default ladspa build is deselected).
443 Note for 32-bit 14.2 Slackware, Debian, Gentoo, Arch, FreeBSD,
444 before running the configure, you will need to set up the following:
446 \begin{lstlisting}[style=sh]
447 export ac_cv_header_xmmintrin_h=no
448 export FFMPEG_EXTRA_CFG=" --disable-vdpau"
451 Note for building 32-bit packages on hybrid 32/64 x86 systems, you may
452 need to add the following:
454 \begin{lstlisting}[style=sh]
455 setarch i686 (befire configure and package build)
458 NOTE: as of May 31, 2021 when Context Help was added, to include
459 this Context Help you will need to download the corresponding
460 tgz file containing the HTML manual sections referenced for the
461 Help pages. The file to download is:
462 \url{https://cinelerra-gg.org/download/images/HTML_Manual-20220131.tgz}
463 substituting for "20220131" the "yyyymmdd" representing latest release date.
464 Then unpack to your Cinelerra/bin/doc directory so it is included in
465 your built system. The reason for not including the HTML manual in
466 the source code so that it would already be there, is because it is
467 very large and has its own GIT base.
469 \subsection{Notes about Building from Git in your Customized Environment}%
470 \label{sub:notes_about_building_from_git_in_your_customized_environment}
475 Getting a build to work in a custom environment is not easy. If you
476 have already installed libraries which are normally in the
477 thirdparty build, getting them to be recognized means you have to
478 install the \textit{devel} version so the header files which match
479 the library interfaces exist. If you want to build using only the
480 thirdparty libraries installed in your system, just include
481 "--without-thirdparty" to your configure script. For example:
482 \begin{lstlisting}[style=sh]
483 ./confgure --with-single-user --disable-static-build --without-thirdparty
485 Below is the list of thirdparty
486 builds, but this list may have changed over time.
487 % It's list of Table?
491 \begin{longtable}{m{8em} c}
492 \caption{List of thirdparty builds}
493 \label{tab:List_of_thirdparty_builds}\\
536 The \textit{yes} means force build and \textit{auto} means probe and
537 use the system version if the build operation is not static. To get
538 your customized build to work, you need to change the probe options
539 for the conflicting libraries from \textit{yes} to \textit{auto}, or
540 even rework the \texttt{configure.ac} script. There may be several
541 libraries which need special treatment.
543 An example of a problem you might encounter with your customized
544 installation is with \texttt{a52dec} which has probes line
545 \texttt{(CHECK\_LIB/CHECK\_HEADERS)} in \texttt{configure.ac}, but
546 \texttt{djbfft} does not. In this case, \texttt{djbfft} is only
547 built because \texttt{a52dec} is built, so if your system has
548 \texttt{a52dec}, set \texttt{a52dec} to auto and see if that
549 problem is solved by retrying the build with:
550 \begin{lstlisting}[style=sh]
551 ./confgure --with-single-user -enable-a52dec=auto .
554 With persistence, you can get results, but it may take several tries
555 to stabilize the build. If you need help, email the \texttt{log}
556 and \texttt{config.log}, which is usually sufficient to determine
559 If you have already installed the \texttt{libfdk\_aac} development
560 package on your computer because you prefer this version over the
561 default aac, you will have to do the following to get this
562 alternative operational. The libfdk\_aac library is not a part of
563 \CGG{} by default because it is not license free.
565 \begin{lstlisting}[style=sh]
566 export FFMPEG_EXTRA_CFG=" --enable-libfdk-aac --enable-nonfree"
567 export EXTRA_LIBS=" -lfdk-aac"
568 for f in `grep -lw aac cinelerra-5.1/ffmpeg/audio/*`; do
569 sed -e 's/\<aac\>/libfdk_aac/' -i $f
574 \subsection{Cloning the Repository for Faster Updates}%
575 \label{sub:cloning_the_repository_for_faster_updates}
579 If you want to avoid downloading the software every time an update
580 is available you need to create a local ``repository'' or repo. The
581 repo is a directory where you first do a \texttt{git clone}. For
582 the initial git clone, set up a local area for the repository
583 storage, referred to as \texttt{<repo\_path>}. The \texttt{git
584 clone} creates a repo named \texttt{cin5} in the
585 \texttt{/<repo\_path>/} directory. This accesses about 530\,MB of
586 repo data, so the device has to have at least that available. The
587 repo path is always a perfect clone of the main repo.
590 \paragraph{Setting up the initial clone}%
591 \label{par:setting_up_the_initial_clone}
593 You may want to add ``\verb|--depth 1|'' before \texttt{cin5}
594 because this will clone faster and is smaller, but has no history.
596 \begin{lstlisting}[style=sh]
598 git clone "git://git.cinelerra-gg.org/goodguy/cinelerra" cin5
600 Cloning into "cin5"...
601 remote: Counting objects: 20032, done.
602 remote: Compressing objects: 100% (11647/11647), done.
603 remote: Total 20032 (delta 11333), reused 16632 (delta 8189)
604 Receiving objects: 100% (20032/20032), 395.29 MiB | 3.26 MiB/s, done.
605 Resolving deltas: 100% (11333/11333), done.
606 Checking connectivity... done.
610 \paragraph{Update an existing repo}%
611 \label{par:update_an_existing_repo}
612 The below shows how you can get updates.
614 \begin{lstlisting}[style=sh]
620 \paragraph{Useful git commands}%
621 \label{par:useful_git_commands}
622 Some other commands that are useful.
624 \begin{lstlisting}[style=sh]
625 git clone "git://git.cinelerra-gg.org/goodguy/cinelerra.git" cin5
626 git pull # pull remote changes to the local version
627 git status # shows changed files
628 git clean -i # interactive clean, use answer 1 to "clean"
632 \subsection{How to Build from a Previous GIT Version}%
633 \label{sub:how_to_build_from_a_previous_git_version}
638 If you have a problem with the current GIT version, you can revert
639 to a previous working version easily. The commands to use will be
640 similar to these next lines which are then explained in more detail.
641 You need "history" to do this, so should not have used the "depth 1"
642 parameter on your GIT.
645 \begin{lstlisting}[style=sh]
646 cd /<path>/cin5 # substitute your repo path name for cin5
647 git log # shows a list of versions depending on history depth specification
648 git checkout <version> # choose a version number as listed
651 The \texttt{git log} command produces a log file with hash values
652 for commit keys to the level specifed if the the depth paramter
654 The hash ids are the commit names to use when you
655 use git checkout. Next is displayed sample output:
657 \begin{lstlisting}[style=nil]
658 delete stray line in last checkin
660 commit 4a90ef3ae46465c0634f81916b79e279e4bd9961
661 Author: Good Guy <good1.2guy@gmail.com>
662 Date: Thu Feb 22 14:56:45 2018 -0700
664 nested clips, big rework and cleanup, sams new icons,
667 commit f87479bd556ea7db4afdd02297fc00977412b873
668 Author: Good Guy <good1.2guy@gmail.com>
669 Date: Sat Feb 17 18:09:22 2018 -0700
672 For the \texttt{git checkout <version>}, you would then keyin the
673 line below for the following results:
675 \begin{lstlisting}[style=nil]
676 git checkout f87479bd556ea7db4afdd02297fc00977412b873
678 Note: checking out 'f87479bd556ea7db4afdd02297fc00977412b873'.
680 You are in 'detached HEAD' state. You can look around, make
681 experimental changes and commit them, and you can discard any
682 commits you make in this state without impacting any branches by
683 performing another checkout.
685 If you want to create a new branch to retain commits you create,
686 you may do so (now or later) by using -b with the checkout command
689 git checkout -b <new-branch-name>
691 HEAD is now at f87479bd... more file size icon updates,
692 and more to followend
695 Later to get the repo back to current, use:
696 \begin{lstlisting}[style=sh]
701 \subsection{Debuggable Single User Build}%
702 \label{sub:debuggable_single_user_build}
703 \index{single-user build}
706 To build from source with full debugging symbols, first build a full
707 static (non\_debug) build as follows but instead of using
708 \texttt{/tmp} substitute your permanent disk path if you want to
711 \begin{lstlisting}[style=sh]
713 git clone --depth 1 "git://git.cinelerra-gg.org/goodguy/cinelerra.git" cinelerra5
714 cp -a /<repo_path>/cinelerra-5.1 /tmp/
715 cd /tmp/cinelerra-5.1
719 Then, to run as a developer in the debugger:
721 \begin{lstlisting}[style=sh]
722 CFLAGS="-O2 -ggdb" make -j8 rebuild_all
727 When you get the gdb prompt, type the letter "r", for run, and the windows will come up.
728 If there is a crash, the windows will freeze and typing "bt" for backtrace in the startup window
729 after the gdb prompt, provides useful information.
732 \subsection{Unbundled Builds}%
733 \label{sub:unbundled_builds}
738 There are some generic build scripts included in the \CGG{} GIT
739 repository for users who want to do unbundled builds with ffmpeg
740 already available on their system. This has been tested on Arch,
741 Ubuntu 18, FreeBSD, Windows10 and Leap 15 (rpm) at the time this
744 The names of the build scripts are: \texttt{arch.bld},
745 \texttt{bsd.bld}, \texttt{deb.bld}, \texttt{rpm.bld}, and
746 \texttt{cygwin.bld}. These scripts are in the \texttt{blds}
747 subdirectory. The \texttt{bsd.bld} should be used with the
748 \texttt{bsd.patch} file in that same directory. The
749 \texttt{cygwin.bld} should be used with the \texttt{cygwin.patch}
750 file in that same directory.
752 The reason that Cin Infinity traditionally uses its own thirdparty builds
753 (bundled builds) is because there are a lot of different distros
754 with varying levels of ffmpeg and other needed thirdparty
755 libraries. However, some users prefer using their current system
756 baseline without another/different copy of ffmpeg.
758 With different levels of the user’s libraries, uncertainty,
759 potential instability, and unknown issues may come up while
760 running \CGG{} and this will make it, for all practical purposes,
761 impossible to diagnose and debug problems or crashes.
763 There may be no help in these cases. You are encouraged to report
764 any errors which potentially originate from Cin Infinity, but if
765 the data indicates alternate library sources, please report the
766 problems to the appropriate maintainers.
768 With the unbundled builds, some features may not be available and
769 no attempt to comment them out has been made. So if you use a
770 pulldown, or pick a render option, or choose something that is not
771 available, it just will not work. For example, unless special
772 options were set up by you, the LV2 audio plugins will not be
773 available. Nor will the codec libzmpeg, the file codec ac3, or
774 DVD creation. The old school file classes will all work, but some
775 of the formats that come with ffmpeg may not because of the way
776 that ffmpeg was installed on your operating system. That is
777 because the \CGG{} included ffmpeg is a known static build and is
778 usually the latest stable/released version. For example, in the
779 current case of Leap 15, libx264 and libx265 are not built in and
780 this can be debilitating; you can always run \texttt{ffmpeg
781 -formats} and \texttt{ffmpeg -codecs} to see what is available
784 \section{Building the HTML Manual for Context Help}%
785 \label{sec:building_the_manual}
788 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.
790 The steps are as follows:
792 \item Download the manual in LaTeX:
794 \begin{lstlisting}[style=sh]
795 git clone "git://git.cinelerra-gg.org/goodguy/cin-manual-latex.git" master
798 \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):
799 \begin{lstlisting}[style=sh]
803 The steps that this script performs are as follows:
805 \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.
807 \begin{lstlisting}[style=sh]
808 pdflatex CinelerraGG_Manual.tex
809 makeindex CinelerraGG_Manual.idx
810 pdflatex CinelerraGG_Manual.tex
811 makeindex CinelerraGG_Manual.nlo -s nomencl.ist -o CinelerraGG_Manual.nls
812 pdflatex CinelerraGG_Manual.tex
815 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.
816 \item Next, to produce HTML output the script then moves (renames) \texttt{latex 2html-init} to \texttt{.latex2html-init} (starting with dot).
818 \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.
821 \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.
823 \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.
826 \section{Windows 10 with Cygwin for \CGG{} Limited}%
827 \label{sec:ms_windows10}
830 As of 10/31/2020, this is no longer being maintained. It should
831 still work using an older GIT version with Windows 10 but it is
832 possible with some effort to modify the patch file to work with the
835 To run \CGG{} on a Windows 10 computer, you will need to have
836 Cygwin installed on your system, along with the \CGG{} static tar
837 and a patched library: libxcb. This setup has been tested with
838 Windows 10, version 1909, on an HP EliteBook 820 at 2.3 GHz.
840 This limited version provides \textit{core} functionality at this
841 time with the standard Windows FFmpeg executable, meaning that
842 specific modifications in FFmpeg needed for \CGG{} are not
843 available. Limited capabilities include only a few render output
844 formats available - for example \textit{mov}, \textit{qt} as
845 \textit{mjpeg}, and \textit{mpeg} for videos and \textit{avi} and
846 \textit{qt} as \textit{s16le} for audio, but not \textit{mkv} or
847 \textit{mp4}. This is due to the fact that several codec and
848 utility libraries are not currently compiled to work with Windows.
850 \subsection*{Installing Cygwin}
851 \label{sec:installing_cygwin}
854 Cygwin is an environment that runs natively on Windows which
855 allows Unix programs to be compiled and run on Windows. With
856 cygwin installed on your Windows 10 computer, you will be able to
857 run \CGG{}. Before installing cygwin, you need to be warned that
858 the Avast anti-virus software kills files necessary for cygwin
859 installation and execution, so you will have to remove it and use
860 alternative anti-virus software (the standard default already
861 included with Windows 10 is Defender). Below are the steps for
865 \item Download cygwin for your 64-bit computer at:
866 \href{https://www.cygwin.com/}{https://www.cygwin.com/}
868 \item Generally just take the defaults as they show up, but the
869 next steps show what comes up.
871 \item When a warning window pops up, click \textit{Yes}.
873 \item Click \textit{Next}.
875 \item Choose \textit{Install from Internet} option and then click
878 \item Choose your desired directory by clicking on Browse
879 button. Choose \textit{All Users (Recommended)} and then click
882 \item Choose the local package directory where you would like your
883 installation files to be placed. Click \textit{Next}.
885 \item Choose \textit{Direct Connection} if you are using Internet
886 with plug and play device. Click \textit{Next}.
888 \item Choose any download site preferably
889 ``cygwin.mirror.constant.com'' and then click \textit{Next}.
891 \item For list of things to install, leave all set to
892 \textit{Default} except these to \textit{Install} instead:
901 This install takes a long time; approximately 2 hours on an
902 EliteBook and requires approximately 20GB storage.
904 \item Finally you will want to have the icons on your desktop
905 (already default) and then click \textit{Finish}.
908 Then to install the \CGG{} tar files, you will need to start a
909 cygwin console terminal from the startup menu as shown here:
910 \texttt{Start $\rightarrow$ Cygwin $\rightarrow$ Cygwin64}
913 \subsection*{Installing \CGG{}}
914 \label{sec:installing_cinelerra}
917 \item Download the tar file
918 \href{https://cinelerra-gg.org/download/testing/libxcb-bld.tar.bz2}{libxcb-bld.tar.bz2}.
920 \item Install libxcb from the tar file -- installs into
921 \texttt{/usr/local} and requires approximately 21MB storage.
922 \begin{lstlisting}[style=sh]
923 tar -C /usr/local -xJf /path/libxcb-bld.tar.bz2
925 The libxcb patch repairs an error (XIOError), which stops
928 \item Download the tar file
929 \href{https://cinelerra-gg.org/download/testing/cygcin-bld.tar.bz2}{cygcin-bld.tar.bz2}.
931 \item Install cygcin from the tar file - this installs into home
932 directory. Note this is cygcin \emph{not} cygwin. You must change the
933 \texttt{path} below to the name of the path where you downloaded
935 \begin{lstlisting}[style=sh]
937 tar -xJf /path/cygcin-bld.tar.bz2
941 This creates \texttt{\~{}/cygcin}, a user build installation of
942 \CGG{} and requires approximately 400MB storage.
944 \paragraph{Running \CGG{}:}
945 You will need to start a cygwin desktop from the startup menu:
947 \item \texttt{Start$\rightarrow$ Cygwin-X $\rightarrow$ Openbox}
949 You should start a console controlling terminal so that you can
952 \item \texttt{Start$\rightarrow$ Cygwin $\rightarrow$ Cygwin64} Terminal
954 This opens a separate window that can survive a cygwin hang and
955 bugs. Without these logs, it is much more difficult to use.
957 \item Type into that console controlling window, the following:
958 \begin{lstlisting}[style=sh]
962 \item Change directories to where \CGG{} is installed:
963 \begin{lstlisting}[style=sh]
964 cd /path/cygcin (NOT cygwin)
968 \begin{lstlisting}[style=sh]
971 which starts up your 4 \CGG{} windows.
974 The most noticeable difference from the Linux versions is that
975 \CGG{} seems to run very slowly on Windows 10. You must be very
976 tolerant and patient to see this work. It can however exhibit
977 astonishing speed when encoding. \CGG{} has to be downgraded
978 significantly due to lack of supported interfaces, codecs (for
979 example h264/h265), and utilities. The only graphics driver is
980 X11 and the only sound driver is pulseaudio. Almost all
981 configurable omissions are applied to this build.
983 \paragraph{\CGG{} build on cygwin from source code:}
986 \item Download and install ffmpeg into /usr/local :
988 download ffmpeg (currently 4.2.2)
989 \begin{lstlisting}[style=sh]
991 tar -xJf /path/ffmpeg-4.2.2.tar.bz2
998 \item Download and install a patched libxcb:
999 \begin{lstlisting}[style=sh]
1002 tar -xf /path/libxcb-1.13.tar.bz2
1004 patch -p1 < /path/cinelerra-5.1/thirdparty/src/libxcb.patch1
1005 patching file configure.ac
1006 patching file src/xcb_in.c
1012 \item Download cinelerra-gg:
1013 \begin{lstlisting}[style=sh]
1015 git clone "git://git.cinelerra-gg.org/goodguy/cinelerra.git"
1016 cd cinelerra-gg/cinelerra-5.1
1018 \item Apply cygwin patch:
1019 \begin{lstlisting}[style=sh]
1020 patch -p2 < blds/cygwin.patch
1022 \item Run the build with:
1023 \begin{lstlisting}[style=sh]
1028 This produces a directory: /build\_path/cinelerra-gg/cinelerra-5.1/bin
1029 which is used to create the cygcin archive.
1031 Currently, the targets are not stripped and can be run from gdb.
1032 There is only very limited signal handler dmp file support.
1033 Running gdb from inside a desktop resident console (not a cygwin64
1034 window) will hang cygwin (and cin) when it hits a breakpoint. You
1035 must run from an external console window to avoid this issue.
1037 \section{Android Tablet or Phone with TERMUX}%
1038 \label{sec:android_termux}
1041 \CGG{} can be run on Android (without audio), a non-x86 mostly posix system,
1042 tablet or phone after installing TERMUX, the \textit{terminal emulator}.
1043 You will have to do your own build using the file in Cinelerra's
1044 \texttt{blds} subdirectory, \texttt{termux.bld}.
1045 Because this is a relatively new capability and of lesser use, some
1046 additional effort may have to be exerted on your part to get it going
1047 but it is easy to get help by contacting the mailing list.
1048 In addition, there is currently no known procedure for hearing audio.
1050 \begin{figure}[htpb]
1052 \includegraphics[width=1.0\linewidth]{android.png}
1053 \caption{Screencast of an Android tablet running \CGG{} using TERMUX.}
1057 Some requirements include;
1059 \item Termux runs with X on Android 7+.
1060 \item Install takes 5 GB of internal storage. In addition you can download videos,
1061 and other files with wget to one specific location at sdcard after running termux-setup-storage
1062 inside termux (it will prompt you to give access to sdcard graphically the first time used).
1063 \item If you have empty versions of \texttt{locale.alias}, \texttt{locale.dir},
1065 \newline \texttt{\$PREFIX/share/X11/locale/en\_US.UTF-8/XLC\_LOCALE}
1066 \newline you will have to request non-empty versions via the mailing list.
1067 \item Some helpful information on installing the X environment is at:
1068 \url{https://wiki.termux.com/wiki/Graphical\_Environment}
1069 \item To prevent crashing when loading a video file that has audio, use the guide
1070 \url{https://www.reddit.com/r/termux/comments/bpa8jz/pulseaudio\_streaming\_client/}
1071 which explains vnc/pulseaudio setup.
1074 A little more about Audio is presented next because you will need to have this running
1075 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.
1076 Some information is available at:
1077 \url{https://android.stackexchange.com/questions/205576/how-to-play-sound-from-termux-when-using-linux} .
1079 The next few lines show a successful setup/usage.
1080 \begin{lstlisting}[style=sh]
1081 $ pulseaudio --start
1083 PID TTY STAT TIME MAJFL TRS DRS RSS %MEM COMMAND
1084 7003 pts/28 S<s 0:00 637 532 9039 1716 0.0 /data/data/com
1085 13684 ? S<l 0:00 0 49 123898 16616 0.8 pulseaudio --
1086 13692 pts/28 R<+ 0:00 0 63 7500 1420 0.0 ps axv
1088 \begin{lstlisting}[style=sh]
1089 $ pactl load-module module-native-protocol-tcp auth-ip-acl=127.0.0.1 auth-anonymous=116
1090 $ PULSE_SERVER=127.0.0.1 pactl info
1091 Server String: 127.0.0.1
1092 Library Protocol Version: 34
1093 Server Protocol Version: 34
1098 Host Name: localhost
1099 Server Name: pulseaudio
1100 Server Version: 14.2
1101 Default Sample Specification: s16le 2ch 44100Hz
1102 Default Channel Map: front-left,front-right
1103 Default Sink: OpenSL_ES_sink
1104 Default Source: OpenSL_ES_sink.monitor
1108 Now to start up \CGG{}, type in:
1109 \begin{lstlisting}[style=sh]
1110 $ cd (your cinelerra directory)/cinelerra/cinelerra-5.1/
1111 $ PULSE_SERVER=127.0.0.1 ./cin.sh
1114 You can even build a package version similiar to Debian, just with "\texttt{pkg search} pkg\_name / \texttt{pkg install}
1115 pkg\_name" instead of "\texttt{apt search/install} pkg\_name" and with "\texttt{*-static}" instead of "\texttt{*-dev/-devel} packages".
1116 For more information on this, see:
1118 \url{https://wiki.termux.com/wiki/Package\_Management}
1119 \newline \url{https://wiki.termux.com/wiki/Building\_packages}
1121 \section{Distro with \CGG{} Included}%
1122 \label{sec:distro_with_cinelerra_included}
1123 \index{linux distro}
1125 There are also some special complete distribution systems
1126 available that include \CGG{} for audio and video production
1129 \subsection{AV Linux}
1130 \label{sec:AV_Linux}
1132 \textbf{AV Linux} is a downloadable/installable shared snapshot
1133 ISO image based on MX Linux. It provides the user an easy method to
1134 get an Audio and Video production workstation without the hassle
1135 of trying to find and install all of the usual components
1136 themselves. Of course, it includes \CGG{}!
1139 \href{http://www.bandshed.net/avlinux/}{homepage of AV Linux}.
1141 \subsection{Bodhi Linux Media}
1142 \label{sec:Bodhi_Linux}
1144 \textbf{Bodhi Linux Media} is a free and open source distribution that
1145 comes with a curated list of open source software for digital
1146 artists who work with audio, video, includes \CGG{}, games,
1147 graphics, animations, physical computing, etc.
1150 \href{https://gitlab.com/giuseppetorre/bodhilinuxmedia}{homepage of Bodhi Linux}.
1152 \subsection{DeLinuxCo}
1153 \label{sec:delinuxco}
1155 \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{}.
1157 You can read all about DeLinuxCo \href{https://www.delinuxco.com/}{here} and download \href{https://www.delinuxco.com/download/}{here}.
1162 \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.
1164 Click \href{https://www.elivecd.org/}{Elive} for more information. The \CGG{} packages for the program
1165 and the manual are in the direcotry at
1166 \href{https://repo.bullseye.elive.elivecd.org/pool/multimedia/c/} {Bullseye version 11} and
1167 \href{http://repo.buster.elive.elivecd.org/pool/multimedia/c/}{Buster version 10} - just download
1168 the .deb files inside that directory and install via “dpkg -i “.
1170 \section{Cinx and a “Bit” of Confusion}%
1171 \label{sec:cinx_and_a_bit_of_confusion}
1174 Cinx is the exact same program as Cin. The X (x) represents the
1175 roman numeral 10 for 10-bit as opposed to 8-bit standard. The
1176 third-party library used for x265 must be specially compiled with
1177 \texttt{--bit-depth=10} in order to produce 10-bit rendered
1178 output. A cinx version can be built for most other distros if
1179 rendering at 10-bit is desirable instead of 8-bit.
1181 This build will not be able to output 8-bit depth which means you
1182 have to retain the Cin version also.
1184 Whatever build ffmpeg is linked to will determine what bit depth
1185 it can output. This is why there have to be separate builds. If
1186 you install both packages, Cin and CinX, you may get \textit{file
1187 conflicts of same file name} --- just continue.
1189 Keep in mind that the regular 8-bit version works on 8-bit bytes
1190 --- the standard word size for computers, but the 10-bit version
1191 has to use 2 words to contain all 10 bits so you can expect
1192 rendering to be as much as twice as slow.
1194 There is also a 12-bit version for consideration but currently the
1195 results are simply the same as 10-bit with padding to make 12-bit
1196 so it is of no value.
1198 \section{Multibit build for x265-8/10/12-bit}%
1199 \label{sec:multibit_build}
1202 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:
1204 \begin{lstlisting}[style=sh]
1205 cd /path/to/cinelerra-5.1/thirdparty
1206 patch < compile_multibit_X265.txt
1207 mv x265_3.5.patch* src/.
1209 Render formats \textit{h265-10bit} and \textit{h265-12bit} have been provided and will
1210 be operational after the applied patch is compiled in.
1212 %%% Local Variables:
1214 %%% TeX-master: "../CinelerraGG_Manual"