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 and 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:
16 Download the file from:
18 \url{https://cinelerra-gg.org/download/images/}
20 Some example file names are as follows - where 8 digits represent yyyymmdd:
22 \begin{lstlisting}[style=sh]
23 CinGG-20210731-x86_64.AppImage
24 (currently based on Fedora Core 32, libc version 2.31)
25 CinGG-20210731-x86_64-older-distros.AppImage
26 (currently based on Ubuntu 16.04, libc version 2.23)
27 CinGG-20210731-i686.AppImage
28 (currently based on Debian 9, linux kernel 4.9)
29 CinGG-20210731-x86_64-multibit.AppImage
30 (currently based on Fedora Core 32, libc version 2.31)
33 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:
35 \begin{lstlisting}[style=sh]
36 $ chmod u+x CinGG-yyyymmdd.AppImage
39 Finally start the program from a window in the directory where the image is stored:
41 \begin{lstlisting}[style=sh]
42 $ ./CinGG-yyyymmdd.AppImpage
45 or create a convenient desktop icon with a link to the run action, or do a \textit{Desktop Integration} manually or with external programs.
47 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.
49 \begin{lstlisting}[style=sh]
50 sudo pacman -S libappimage
53 And Leap 15.3 (OpenSUSE) requires installation of the \textit{appimage} package.
55 \begin{lstlisting}[style=sh]
56 sudo zypper se -is appimage
59 \section{Download Already Built \CGG{}}%
60 \label{sec:download_already_built_cinelerra_gg}
64 \includegraphics[width=1.0\linewidth]{download-distros.png}
65 \caption{Screencast of the website Download page for installing \CGG{} for various O/S.}
66 \label{fig:download-distros}
69 If you prefer to not have to take the time to build \CGG{} Infinity
70 yourself, there are pre-built dynamic or static binaries for various
71 versions of Ubuntu, Mint, Suse, Fedora, Debian, Centos, Arch, and
72 Slackware linux as well as Gentoo and FreeBSD. If you do want to build it yourself so that
73 you get the added benefit of the latest checked in changes, please reference
74 ~\ref{sec:How_to_build}.
76 A Windows 10 version installation is described in~\ref{sec:ms_windows10}. There are also 32-bit i686 Ubuntu, Debian,
77 and Slackware versions available. \textbf{These binaries are no longer being updated; they are stable and working but without future functionality}.
78 They are in subdirectories of:
81 \item \href{https://cinelerra-gg.org/download/tars}{https://cinelerra-gg.org/download/tars}
82 \item \href{https://cinelerra-gg.org/download/pkgs}{https://cinelerra-gg.org/download/pkgs}
85 The \textbf{tars} \index{tars} directory contains single-user static builds for
88 This is the recommended usage of \CGG{} because all of the files
89 will exist in a single directory. Generally all of the necessary
90 libraries are built into the static build, but in some cases you may
91 have to install another library that is being called for.
93 To install the single user builds, download the designated tarball
94 from the \texttt{./tars} subdirectory and unpack as indicated below:
96 \begin{lstlisting}[style=sh]
100 tar -xJf /src/path/cinelerra-5.1-*.txz # for the *, substitute your distro tarball name
103 \emph{Do not download the LEAP 10-bit version unless you specifically want to
104 use h265 rendering to 10-bit instead of the more standard 8-bit.} For more
105 information see ~\ref{sec:cinx_and_a_bit_of_confusion}.
107 The \textbf{pkgs} \index{pkgs} directory contains the standard packaged
108 application for various distros. This will install a dynamic
109 system version for users who prefer to have the binaries in the
110 system area and for multi-user systems.
112 In addition, performing the package install checks the md5sum in
113 the file \texttt{md5sum.txt} to ensure the channel correctly
114 transmits the package. There is a
115 \href{https://cinelerra-gg.org/download/README.pkgs}{README.pkgs}
116 file in the \texttt{download} directory with instructions so you
117 can \textit{cut and paste} and avoid typos; it is also shown
120 \lstset{inputpath=extra/}
123 basicstyle=\footnotesize,
124 caption={README.pkgs}
127 \section{How to Build \CGG{} from Developer's Git Repository}%
128 \label{sec:How_to_build}
132 These are generic build instructions for building \CGG{} Infinity.
133 Known to work on Ubuntu, Mint, OpenSuse, Fedora, Debian, Centos,
134 Arch, Slackware, and Gentoo. It has not been tested on every
135 single possible distro yet so you might expect to have to make
136 some minor changes. Also works on a somewhat limited basis on
137 FreeBSD and Windows 10 with the bsd.patch for FreeBSD and the
138 cygwin.patch for Windows 10.
140 NOTE: as of May 31, 2021 when Context Help was added, to include
141 this Context Help you will need to download the corresponding
142 tgz file containing the HTML manual sections referenced for the
143 Help pages. The file to download is:
144 \url{https://cinelerra-gg.org/download/images/HTML_Manual-20210531.tgz}
145 substituting for "20210531" the "yyyymmdd" representing latest release date.
146 Then unpack to your Cinelerra/bin/doc directory so it is included in
150 Alternatively, there are some pre-built dynamic or static binaries
151 which are updated on a fairly regular basis (as long as code changes
152 have been made) available at the link below.
154 \href{https://cinelerra-gg.org/download/}{https://cinelerra-gg.org/download/}
157 There are 2 kinds of builds, the default system-build and a
158 single-user build. A system build has results which are installed
159 to the system. The majority of the files are installed in the
160 standard system paths, but some customization is possible. The
161 single user build allows for running completely out of a local
162 user directory so it doesn't affect the system.
164 We recommend the single-user version when possible. It makes it
165 very easy to install a new version without having to delete the
166 older version in case you want it for backup -- once you are happy
167 with the new version, all you have to do is delete the entire old
168 directory path. Another reason for using single-user is that if
169 you install a new Operating System version and if you have \CGG{}
170 on separate disk space that is preserved, you won't have to
171 reinstall \CGG{}. It is also convenient for the purpose of having
172 the ability to interrupt or to see any possible error messages, if
173 you start the application from a terminal window command line
174 where you will have more control to catch problems. All that
175 said, the system builds can be useful in a university lab setting
176 where there are possibly multiple users, or multiple versions.
178 There are two notable differences between standard views
179 of \CGG{} and this implementation for the system builds. Both of
180 these can be configured during installation. The differences make
181 it possible to have several different versions installed without
182 having them interfere with each other.
185 \item application name can be set during a build but defaults
187 \item the home configuration directory can also be set and
188 traditionally defaults to: \texttt{\$HOME/.bcast5}
192 \subsection{The system build}
193 \label{sec:system-build}
196 To do a system build \index{build} , you should read the file
197 \texttt{README} that is at the top level after you get the source.
200 \item You need about 6.0 \,GB of disk storage to operate a build and
201 you need to have \textit{git} installed.
203 \item Obviously in order to install into the system, you must run as
206 \item The \textit{git:} step has to download many files (approx
207 130\,MB) so allow time. When decompressed this will expand to
210 \item Run the following commands (this takes awhile):
212 \begin{lstlisting}[style=sh]
213 # This is where you need the 6.0GB of disk space:
215 git clone --depth 1 "git://git.cinelerra-gg.org/goodguy/cinelerra.git" cinelerra5
216 # Change to the cloned directory:
217 cd cinelerra5/cinelerra-5.1
219 NOTE: if your system has never had \CGG{} Infinity installed, you
220 will have to make sure you have all of the compilers and libraries
221 necessary. So on the very first build you should run:
223 \begin{lstlisting}[style=sh]
224 ./blds/bld_prepare.sh <os> # where <os> represents the
225 # Operating System of
226 # centos, fedora, suse, ubuntu, mint, debian.
228 ./configure --prefix=/usr # optional parameters can be added here
229 make 2>&1 | tee log # make and log the build
232 \texttt{bld\_prepare.sh} does not work for Arch Linux or Gentoo,
233 so we have to install the dependencies
234 manually. \texttt{README.arch} or \texttt{README.gentoo}, which
235 contain the list of dependencies, can be found at:
237 \item \href{https://cinelerra-gg.org/download/README.arch}{https://cinelerra-gg.org/download/README.arch}
238 \item \href{https://cinelerra-gg.org/download/README.gentoo}{https://cinelerra-gg.org/download/README.gentoo}
241 \item Check for obvious build errors:
242 \begin{lstlisting}[style=sh]
243 grep "\*\*\*.*error" -ai log
245 If this reports errors and you need assistance or you think
246 improvements can be made to the builds, email the log which is
248 \href{mailto:cin@lists.cinelerra-gg.org}{cin@lists.cinelerra-gg.org}
249 \begin{lstlisting}[style=sh]
250 /<build_path>/cinelerra5/cinelerra-5.1/log
253 \item If there are no build errors, finally just run:
254 \begin{lstlisting}[style=sh]
257 Where <os> represents the Operating System supported by \CGG{}, such
258 as centos, fedora, suse, ubuntu, mint, debian.
259 The ``with-single-user'' parameter makes it so.
260 % Make and log build (
261 Check for errors before proceeding.
264 \item If it all worked, you are all setup. Just click on the \CGG{}
269 \subsection{The single-user build}
270 \label{sec:single-user-build}
271 \index{single-user build}
274 To do a single-user build, read the file \texttt{README} that is at
275 the top level after you get the source.
278 \item You need at least 6\,GB of disk storage to operate a build +
279 you need to have “\texttt{git}” installed.
281 \item Recommend you build and run as \textbf{root}, just to avoid
282 permission issues initially.
283 \item The \textit{git} step has to download many files (approx
284 130\,MB) so allow time.
286 \item Run the following commands (this takes awhile):
287 \begin{lstlisting}[style=sh]
288 # This is where you need the 6GB of disk space
290 git clone --depth 1 "git://git.cinelerra-gg.org/goodguy/cinelerra.git" cinelerra5
291 # Toplevel directory:
292 cd cinelerra5/cinelerra-5.1
296 NOTE: if your system has never had \CGG{} Infinity installed, you
297 will have to make sure all the compilers and libraries necessary are
298 installed. So on the very first build you should run as
301 % FIXME No novels in the listings.
302 \begin{lstlisting}[style=sh]
303 ./blds/bld_prepare.sh <os>
305 ./configure --with-single-user
309 Where <os> represents the Operating System supported by \CGG{}, such
310 as centos, fedora, suse, ubuntu, mint, debian.
311 The ``with-single-user'' parameter makes it so.
312 % Make and log build (
313 Check for errors before proceeding.
316 Then just start the application by keying in: \texttt{./cin} in the
317 bin subdirectory OR add a desktop icon by using the appropriate
318 directory to copy the files to, run as \textbf{root}, and edit to
319 correct the directory path. Below are generic directions of how to
322 Then just start the application by keying in: \texttt{./cin} in the
323 bin subdirectory OR add a desktop icon by using the appropriate
324 directory to copy the files to, run as \textbf{root}, and edit to
325 correct the directory path. Below are generic directions of how to
328 \begin{lstlisting}[style=sh]
329 cd /cinelerra_directory_path
330 cp -a image/cin.{svg,xpm} /usr/share/pixmaps/
331 cp -a image/cin.desktop /usr/share/applications/cin.desktop
334 After you have followed the above, in the cin.desktop file, change
335 the \texttt{Exec=cin} line to be
336 \texttt{Exec=<your\_directory\_path>/bin/cin}.
338 The preceding directions for doing a single-user build may work
339 without being root on some distros except for the \texttt{bld\_prepare.sh}
340 and creating the desktop icon. For example in Arch Linux installing without being root
341 works using the following steps:
343 \begin{lstlisting}[style=sh]
344 $ git clone --depth 1 "git://git.cinelerra-gg.org/goodguy/cinelerra.git" cinelerra5
345 $ cd /home/USER/cinelerra5/cinelerra-5.1
347 $ ./configure --prefix=/usr --with-single-user --with-booby
348 $ make 2>&1 | tee /tmp/cin5.log && make install
352 \subsection{Notable Options and Caveats}%
353 \label{sub:notable_options_and_caveats}
356 These procedures and the \CGG{} Infinity software have all been run
357 as \textbf{root} on various home laptops and desktops. This provides
358 the best chance to ensure all works correctly and also allows for
359 handling errors, other problems and potential crashes with the most
360 success. Included in this section are some of the build variations
361 easily available for normal builds.
363 To see the full list of features use:
365 \begin{lstlisting}[style=sh]
368 The default build \index{build} is a system build which uses:
370 \begin{lstlisting}[style=sh]
371 ./configure --without-single-user
374 In the single-user build \index{single-user build}, the target directory is always
375 \texttt{cin}. Because this is also the developer build, constant
376 names are used throughout. However, you can rename files after the
379 If your operating system has issues with the default install to
380 \texttt{/usr/local}, you might have to change the location to
381 \texttt{/usr} for a system build. Then you will have to use:
382 \begin{lstlisting}[style=sh]
383 ./configure --prefix=/usr
386 If you wish to change the default directory for a system build you
387 will have to add the destination directory path on the \texttt{make
388 install} line. For example:
389 \begin{lstlisting}[style=sh]
390 make install DESTDIR=<your selected target directory path>
393 The application name can be set during installation, but defaults to
394 \texttt{cin} so that the GG/Infinity build can coexist with other
395 \CGG{} builds if necessary. To override the default \texttt{cin}
397 \begin{lstlisting}[style=sh]
398 ./configure --with-exec-name=cinelerra
401 The home configuration directory can also be set, but default
402 location is traditionally \texttt{\$HOME/.bcast5}. For example:
404 \begin{lstlisting}[style=sh]
405 ./configure -with-config-dir=/myusername/.bcast5
408 NOTE: when you specify parameters to the configure program, it will
409 create a \texttt{make} file as a consequence. Since in a
410 \texttt{make} file, the \$ is a special character, it must be
411 escaped so in order to represent a \$ as part of an input parameter,
412 it has to be stuttered. That is, you will need \$\$ (2 dollar
413 signs) to represent a single dollar sign.
415 It may be necessary on some distros which have missing or incomplete
416 up-to-date libraries, to build \CGG{} without Ladspa. To do so,
419 \begin{lstlisting}[style=sh]
420 ./configure --prefix=/usr --without-ladspa-build
423 Note that the with-ladspa-dir is the ladspa search path, and
424 exists even if the ladspa build is not selected. This gives you
425 the ability to specify an alternate ladspa system path by
426 utilizing the \texttt{LADSPA\_PATH} environment variable (that is,
427 the default ladspa build is deselected).
429 Note for 32-bit 14.2 Slackware, Debian, Gentoo, Arch, FreeBSD,
430 before running the configure, you will need to set up the following:
432 \begin{lstlisting}[style=sh]
433 export ac_cv_header_xmmintrin_h=no
434 export FFMPEG_EXTRA_CFG=" --disable-vdpau"
437 NOTE: as of May 31, 2021 when Context Help was added, to include
438 this Context Help you will need to download the corresponding
439 tgz file containing the HTML manual sections referenced for the
440 Help pages. The file to download is:
441 \url{https://cinelerra-gg.org/download/images/HTML_Manual-20210531.tgz}
442 substituting for "20210531" the "yyyymmdd" representing latest release date.
443 Then unpack to your Cinelerra/bin/doc directory so it is included in
444 your built system. The reason for not including the HTML manual in
445 the source code so that it would already be there, is because it is
446 very large and has its own GIT base.
448 \subsection{Notes about Building from Git in your Customized Environment}%
449 \label{sub:notes_about_building_from_git_in_your_customized_environment}
454 Getting a build to work in a custom environment is not easy. If you
455 have already installed libraries which are normally in the
456 thirdparty build, getting them to be recognized means you have to
457 install the \textit{devel} version so the header files which match
458 the library interfaces exist. Below is the list of thirdparty
459 builds, but this list may have changed over time.
460 % It's list of Table?
464 \begin{longtable}{m{8em} c}
465 \caption{List of thirdparty builds}
466 \label{tab:List_of_thirdparty_builds}\\
509 The \textit{yes} means force build and \textit{auto} means probe and
510 use the system version if the build operation is not static. To get
511 your customized build to work, you need to change the probe options
512 for the conflicting libraries from \textit{yes} to \textit{auto}, or
513 even rework the \texttt{configure.ac} script. There may be several
514 libraries which need special treatment.
516 An example of a problem you might encounter with your customized
517 installation is with \texttt{a52dec} which has probes line
518 \texttt{(CHECK\_LIB/CHECK\_HEADERS)} in \texttt{configure.ac}, but
519 \texttt{djbfft} does not. In this case, \texttt{djbfft} is only
520 built because \texttt{a52dec} is built, so if your system has
521 \texttt{a52dec}, set \texttt{a52dec} to auto and see if that
522 problem is solved by retrying the build with:
523 \begin{lstlisting}[style=sh]
524 ./confgure --with-single-user -enable-a52dec=auto .
527 With persistence, you can get results, but it may take several tries
528 to stabilize the build. If you need help, email the \texttt{log}
529 and \texttt{config.log}, which is usually sufficient to determine
532 If you have already installed the \texttt{libfdk\_aac} development
533 package on your computer because you prefer this version over the
534 default aac, you will have to do the following to get this
535 alternative operational. The libfdk\_aac library is not a part of
536 \CGG{} by default because it is not license free.
538 \begin{lstlisting}[style=sh]
539 export FFMPEG_EXTRA_CFG=" --enable-libfdk-aac --enable-nonfree"
540 export EXTRA_LIBS=" -lfdk-aac"
541 for f in `grep -lw aac cinelerra-5.1/ffmpeg/audio/*`; do
542 sed -e 's/\<aac\>/libfdk_aac/' -i $f
547 \subsection{Cloning the Repository for Faster Updates}%
548 \label{sub:cloning_the_repository_for_faster_updates}
552 If you want to avoid downloading the software every time an update
553 is available you need to create a local ``repository'' or repo. The
554 repo is a directory where you first do a \texttt{git clone}. For
555 the initial git clone, set up a local area for the repository
556 storage, referred to as \texttt{<repo\_path>}. The \texttt{git
557 clone} creates a repo named \texttt{cin5} in the
558 \texttt{/<repo\_path>/} directory. This accesses about 530\,MB of
559 repo data, so the device has to have at least that available. The
560 repo path is always a perfect clone of the main repo.
563 \paragraph{Setting up the initial clone}%
564 \label{par:setting_up_the_initial_clone}
566 You may want to add ``\verb|--depth 1|'' before \texttt{cin5}
567 because this will clone faster and is smaller, but has no history.
569 \begin{lstlisting}[style=sh]
571 git clone "git://git.cinelerra-gg.org/goodguy/cinelerra" cin5
573 Cloning into "cin5"...
574 remote: Counting objects: 20032, done.
575 remote: Compressing objects: 100% (11647/11647), done.
576 remote: Total 20032 (delta 11333), reused 16632 (delta 8189)
577 Receiving objects: 100% (20032/20032), 395.29 MiB | 3.26 MiB/s, done.
578 Resolving deltas: 100% (11333/11333), done.
579 Checking connectivity... done.
583 \paragraph{Update an existing repo}%
584 \label{par:update_an_existing_repo}
585 The below shows how you can get updates.
587 \begin{lstlisting}[style=sh]
593 \paragraph{Useful git commands}%
594 \label{par:useful_git_commands}
595 Some other commands that are useful.
597 \begin{lstlisting}[style=sh]
598 git clone "git://git.cinelerra-gg.org/goodguy/cinelerra.git" cin5
599 git pull # pull remote changes to the local version
600 git status # shows changed files
601 git clean -i # interactive clean, use answer 1 to "clean"
605 \subsection{How to Build from a Previous GIT Version}%
606 \label{sub:how_to_build_from_a_previous_git_version}
611 If you have a problem with the current GIT version, you can revert
612 to a previous working version easily. The commands to use will be
613 similar to these next lines which are then explained in more detail.
616 \begin{lstlisting}[style=sh]
617 cd /<path>/cin5 # substitute your repo path name for cin5
618 git log # shows a list of versions depending on history depth specification
619 git checkout <version> # choose a version number as listed
622 The \texttt{git log} command produces a log file with hash values
623 for commit keys to the level specifed if the the depth paramter
625 The hash ids are the commit names to use when you
626 use git checkout. Next is displayed sample output:
628 \begin{lstlisting}[style=nil]
629 delete stray line in last checkin
631 commit 4a90ef3ae46465c0634f81916b79e279e4bd9961
632 Author: Good Guy <good1.2guy@gmail.com>
633 Date: Thu Feb 22 14:56:45 2018 -0700
635 nested clips, big rework and cleanup, sams new icons,
638 commit f87479bd556ea7db4afdd02297fc00977412b873
639 Author: Good Guy <good1.2guy@gmail.com>
640 Date: Sat Feb 17 18:09:22 2018 -0700
643 For the \texttt{git checkout <version>}, you would then keyin the
644 line below for the following results:
646 \begin{lstlisting}[style=nil]
647 git checkout f87479bd556ea7db4afdd02297fc00977412b873
649 Note: checking out 'f87479bd556ea7db4afdd02297fc00977412b873'.
651 You are in 'detached HEAD' state. You can look around, make
652 experimental changes and commit them, and you can discard any
653 commits you make in this state without impacting any branches by
654 performing another checkout.
656 If you want to create a new branch to retain commits you create,
657 you may do so (now or later) by using -b with the checkout command
660 git checkout -b <new-branch-name>
662 HEAD is now at f87479bd... more file size icon updates,
663 and more to followend
666 Later to get the repo back to current, use:
667 \begin{lstlisting}[style=sh]
672 \subsection{Debuggable Single User Build}%
673 \label{sub:debuggable_single_user_build}
674 \index{single-user build}
677 To build from source with full debugging symbols, first build a full
678 static (non\_debug) build as follows but instead of using
679 \texttt{/tmp} substitute your permanent disk path if you want to
682 \begin{lstlisting}[style=sh]
684 git clone --depth 1 "git://git.cinelerra-gg.org/goodguy/cinelerra.git" cinelerra5
685 cp -a /<repo_path>/cinelerra-5.1 /tmp/
686 cd /tmp/cinelerra-5.1
690 Then, to run as a developer in the debugger:
692 \begin{lstlisting}[style=sh]
693 CFLAGS="-O2 -ggdb" make -j8 rebuild_all
699 \subsection{Unbundled Builds}%
700 \label{sub:unbundled_builds}
705 There are some generic build scripts included in the \CGG{} GIT
706 repository for users who want to do unbundled builds with ffmpeg
707 already available on their system. This has been tested on Arch,
708 Ubuntu 18, FreeBSD, Windows10 and Leap 15 (rpm) at the time this
711 The names of the build scripts are: \texttt{arch.bld},
712 \texttt{bsd.bld}, \texttt{deb.bld}, \texttt{rpm.bld}, and
713 \texttt{cygwin.bld}. These scripts are in the \texttt{blds}
714 subdirectory. The \texttt{bsd.bld} should be used with the
715 \texttt{bsd.patch} file in that same directory. The
716 \texttt{cygwin.bld} should be used with the \texttt{cygwin.patch}
717 file in that same directory.
719 The reason that Cin Infinity traditionally uses its own thirdparty builds
720 (bundled builds) is because there are a lot of different distros
721 with varying levels of ffmpeg and other needed thirdparty
722 libraries. However, some users prefer using their current system
723 baseline without another/different copy of ffmpeg.
725 With different levels of the user’s libraries, uncertainty,
726 potential instability, and unknown issues may come up while
727 running \CGG{} and this will make it, for all practical purposes,
728 impossible to diagnose and debug problems or crashes.
730 There may be no help in these cases. You are encouraged to report
731 any errors which potentially originate from Cin Infinity, but if
732 the data indicates alternate library sources, please report the
733 problems to the appropriate maintainers.
735 With the unbundled builds, some features may not be available and
736 no attempt to comment them out has been made. So if you use a
737 pulldown, or pick a render option, or choose something that is not
738 available, it just will not work. For example, unless special
739 options were set up by you, the LV2 audio plugins will not be
740 available. Nor will the codec libzmpeg, the file codec ac3, or
741 DVD creation. The old school file classes will all work, but some
742 of the formats that come with ffmpeg may not because of the way
743 that ffmpeg was installed on your operating system. That is
744 because the \CGG{} included ffmpeg is a known static build and is
745 usually the latest stable/released version. For example, in the
746 current case of Leap 15, libx264 and libx265 are not built in and
747 this can be debilitating; you can always run \texttt{ffmpeg
748 -formats} and \texttt{ffmpeg -codecs} to see what is available
751 \section{Building the HTML Manual for Context Help}%
752 \label{sec:building_the_manual}
755 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.
757 The steps are as follows:
759 \item Download the manual in LaTeX:
761 \begin{lstlisting}[style=sh]
762 git clone "git://git.cinelerra-gg.org/goodguy/cin-manual-latex.git" master
765 \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):
766 \begin{lstlisting}[style=sh]
770 The steps that this script performs are as follows:
772 \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.
774 \begin{lstlisting}[style=sh]
775 pdflatex CinelerraGG_Manual.tex
776 makeindex CinelerraGG_Manual.idx
777 pdflatex CinelerraGG_Manual.tex
778 makeindex CinelerraGG_Manual.nlo -s nomencl.ist -o CinelerraGG_Manual.nls
779 pdflatex CinelerraGG_Manual.tex
782 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.
783 \item Next, to produce HTML output the script then moves (renames) \texttt{latex 2html-init} to \texttt{.latex2html-init} (starting with dot).
785 \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.
788 \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.
790 \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.
793 \section{Windows 10 with Cygwin for \CGG{} Limited}%
794 \label{sec:ms_windows10}
797 To run \CGG{} on a Windows 10 computer, you will need to have
798 Cygwin installed on your system, along with the \CGG{} static tar
799 and a patched library: libxcb. This setup has been tested with
800 Windows 10, version 1909, on an HP EliteBook 820 at 2.3 GHz.
802 This limited version provides \textit{core} functionality at this
803 time with the standard Windows FFmpeg executable, meaning that
804 specific modifications in FFmpeg needed for \CGG{} are not
805 available. Limited capabilities include only a few render output
806 formats available - for example \textit{mov}, \textit{qt} as
807 \textit{mjpeg}, and \textit{mpeg} for videos and \textit{avi} and
808 \textit{qt} as \textit{s16le} for audio, but not \textit{mkv} or
809 \textit{mp4}. This is due to the fact that several codec and
810 utility libraries are not currently compiled to work with Windows.
812 \subsection*{Installing Cygwin}
813 \label{sec:installing_cygwin}
816 Cygwin is an environment that runs natively on Windows which
817 allows Unix programs to be compiled and run on Windows. With
818 cygwin installed on your Windows 10 computer, you will be able to
819 run \CGG{}. Before installing cygwin, you need to be warned that
820 the Avast anti-virus software kills files necessary for cygwin
821 installation and execution, so you will have to remove it and use
822 alternative anti-virus software (the standard default already
823 included with Windows 10 is Defender). Below are the steps for
827 \item Download cygwin for your 64-bit computer at:
828 \href{https://www.cygwin.com/}{https://www.cygwin.com/}
830 \item Generally just take the defaults as they show up, but the
831 next steps show what comes up.
833 \item When a warning window pops up, click \textit{Yes}.
835 \item Click \textit{Next}.
837 \item Choose \textit{Install from Internet} option and then click
840 \item Choose your desired directory by clicking on Browse
841 button. Choose \textit{All Users (Recommended)} and then click
844 \item Choose the local package directory where you would like your
845 installation files to be placed. Click \textit{Next}.
847 \item Choose \textit{Direct Connection} if you are using Internet
848 with plug and play device. Click \textit{Next}.
850 \item Choose any download site preferably
851 ``cygwin.mirror.constant.com'' and then click \textit{Next}.
853 \item For list of things to install, leave all set to
854 \textit{Default} except these to \textit{Install} instead:
863 This install takes a long time; approximately 2 hours on an
864 EliteBook and requires approximately 20GB storage.
866 \item Finally you will want to have the icons on your desktop
867 (already default) and then click \textit{Finish}.
870 Then to install the \CGG{} tar files, you will need to start a
871 cygwin console terminal from the startup menu as shown here:
872 \texttt{Start $\rightarrow$ Cygwin $\rightarrow$ Cygwin64}
875 \subsection*{Installing \CGG{}}
876 \label{sec:installing_cinelerra}
879 \item Download the tar file
880 \href{https://cinelerra-gg.org/download/testing/libxcb-bld.tar.bz2}{libxcb-bld.tar.bz2}.
882 \item Install libxcb from the tar file -- installs into
883 \texttt{/usr/local} and requires approximately 21MB storage.
884 \begin{lstlisting}[style=sh]
885 tar -C /usr/local -xJf /path/libxcb-bld.tar.bz2
887 The libxcb patch repairs an error (XIOError), which stops
890 \item Download the tar file
891 \href{https://cinelerra-gg.org/download/testing/cygcin-bld.tar.bz2}{cygcin-bld.tar.bz2}.
893 \item Install cygcin from the tar file - this installs into home
894 directory. Note this is cygcin \emph{not} cygwin. You must change the
895 \texttt{path} below to the name of the path where you downloaded
897 \begin{lstlisting}[style=sh]
899 tar -xJf /path/cygcin-bld.tar.bz2
903 This creates \texttt{\~{}/cygcin}, a user build installation of
904 \CGG{} and requires approximately 400MB storage.
906 \paragraph{Running \CGG{}:}
907 You will need to start a cygwin desktop from the startup menu:
909 \item \texttt{Start$\rightarrow$ Cygwin-X $\rightarrow$ Openbox}
911 You should start a console controlling terminal so that you can
914 \item \texttt{Start$\rightarrow$ Cygwin $\rightarrow$ Cygwin64} Terminal
916 This opens a separate window that can survive a cygwin hang and
917 bugs. Without these logs, it is much more difficult to use.
919 \item Type into that console controlling window, the following:
920 \begin{lstlisting}[style=sh]
924 \item Change directories to where \CGG{} is installed:
925 \begin{lstlisting}[style=sh]
926 cd /path/cygcin (NOT cygwin)
930 \begin{lstlisting}[style=sh]
933 which starts up your 4 \CGG{} windows.
936 The most noticeable difference from the Linux versions is that
937 \CGG{} seems to run very slowly on Windows 10. You must be very
938 tolerant and patient to see this work. It can however exhibit
939 astonishing speed when encoding. \CGG{} has to be downgraded
940 significantly due to lack of supported interfaces, codecs (for
941 example h264/h265), and utilities. The only graphics driver is
942 X11 and the only sound driver is pulseaudio. Almost all
943 configurable omissions are applied to this build.
945 \paragraph{\CGG{} build on cygwin from source code:}
948 \item Download and install ffmpeg into /usr/local :
950 download ffmpeg (currently 4.2.2)
951 \begin{lstlisting}[style=sh]
953 tar -xJf /path/ffmpeg-4.2.2.tar.bz2
960 \item Download and install a patched libxcb:
961 \begin{lstlisting}[style=sh]
964 tar -xf /path/libxcb-1.13.tar.bz2
966 patch -p1 < /path/cinelerra-5.1/thirdparty/src/libxcb.patch1
967 patching file configure.ac
968 patching file src/xcb_in.c
974 \item Download cinelerra-gg:
975 \begin{lstlisting}[style=sh]
977 git clone "git://git.cinelerra-gg.org/goodguy/cinelerra.git"
978 cd cinelerra-gg/cinelerra-5.1
980 \item Apply cygwin patch:
981 \begin{lstlisting}[style=sh]
982 patch -p2 < blds/cygwin.patch
984 \item Run the build with:
985 \begin{lstlisting}[style=sh]
990 This produces a directory: /build\_path/cinelerra-gg/cinelerra-5.1/bin
991 which is used to create the cygcin archive.
993 Currently, the targets are not stripped and can be run from gdb.
994 There is only very limited signal handler dmp file support.
995 Running gdb from inside a desktop resident console (not a cygwin64
996 window) will hang cygwin (and cin) when it hits a breakpoint. You
997 must run from an external console window to avoid this issue.
1000 \section{Distro with \CGG{} Included}%
1001 \label{sec:distro_with_cinelerra_included}
1002 \index{linux distro}
1004 There are also some special complete distribution systems
1005 available that include \CGG{} for audio and video production
1008 \subsection{AV Linux}
1009 \label{sec:AV_Linux}
1011 \textbf{AV Linux} is a downloadable/installable shared snapshot
1012 ISO image based on MX Linux. It provides the user an easy method to
1013 get an Audio and Video production workstation without the hassle
1014 of trying to find and install all of the usual components
1015 themselves. Of course, it includes \CGG{}!
1018 \href{http://www.bandshed.net/avlinux/}{homepage of AV Linux}.
1020 \subsection{Bodhi Linux Media}
1021 \label{sec:Bodhi_Linux}
1023 \textbf{Bodhi Linux Media} is a free and open source distribution that
1024 comes with a curated list of open source software for digital
1025 artists who work with audio, video, includes \CGG{}, games,
1026 graphics, animations, physical computing, etc.
1029 \href{https://gitlab.com/giuseppetorre/bodhilinuxmedia}{homepage of Bodhi Linux}.
1031 \subsection{DeLinuxCo}
1032 \label{sec:delinuxco}
1034 \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{}.
1036 You can read all about DeLinuxCo \href{https://www.delinuxco.com/}{here} and download \href{https://www.delinuxco.com/download/}{here}.
1041 \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.
1043 Click \href{https://www.elivecd.org/}{Elive} for more information. The \CGG{} package is at
1044 \href{http://repository.elivecd.org/pool/multimedia/c/cinelerra-gg/} {package} - just download
1045 the .deb file and install via “dpkg -i “. To include access to the Alt/h hotkey help, also install
1046 \href{http://repository.elivecd.org/pool/multimedia/c/cinelerra-gg-manual/}{manual} for help.
1048 \section{Cinx and a “Bit” of Confusion}%
1049 \label{sec:cinx_and_a_bit_of_confusion}
1052 Cinx is the exact same program as Cin. The X (x) represents the
1053 roman numeral 10 for 10-bit as opposed to 8-bit standard. The
1054 third-party library used for x265 must be specially compiled with
1055 \texttt{--bit-depth=10} in order to produce 10-bit rendered
1056 output. A cinx version can be built for most other distros if
1057 rendering at 10-bit is desirable instead of 8-bit.
1059 This build will not be able to output 8-bit depth which means you
1060 have to retain the Cin version also.
1062 Whatever build ffmpeg is linked to will determine what bit depth
1063 it can output. This is why there have to be separate builds. If
1064 you install both packages, Cin and CinX, you may get \textit{file
1065 conflicts of same file name} --- just continue.
1067 Keep in mind that the regular 8-bit version works on 8-bit bytes
1068 --- the standard word size for computers, but the 10-bit version
1069 has to use 2 words to contain all 10 bits so you can expect
1070 rendering to be as much as twice as slow.
1072 There is also a 12-bit version for consideration but currently the
1073 results are simply the same as 10-bit with padding to make 12-bit
1074 so it is of no value.
1076 \section{Multibit build for x265-8/10/12-bit}%
1077 \label{sec:multibit_build}
1080 To build a version that can handle 8 bit, or 10 bit, or 12 bit videos,
1081 a patch is provided in the \texttt{thirdparty} subdirectory that needs
1082 to be applied to do so. Be aware that the compile may take more time
1083 and seems to be about twice as long. To apply the required patch:
1085 \begin{lstlisting}[style=sh]
1086 cd /path/to/cinelerra-5.1/thirdparty
1087 patch < compile_multibit_X265.txt
1088 mv x265_3.5.patch* src/.
1090 Render formats \textit{h265-10bit} and \textit{h265-12bit} have been provided and will
1091 be operational after the applied patch is compiled in.
1093 %%% Local Variables:
1095 %%% TeX-master: "../CinelerraGG_Manual"