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. 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-20210228-x86_64.AppImage
24 (currently based on Fedora Core 32, libc version 2.31)
25 CinGG-20210228-x86_64-older-distros.AppImage
26 (currently based on Ubuntu 16.04, libc version 2.23)
27 CinGG-20210228-i686.AppImage
28 (not yet available, but will be based on Debian 9, libc version 2.23)
31 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:
33 \begin{lstlisting}[style=sh]
34 $ chmod u+x CinGG-yyyymmdd.AppImage
37 Finally start the program from a window in the directory where the image is stored:
39 \begin{lstlisting}[style=sh]
40 $ ./CinGG-yyyymmdd.AppImpage
43 or create a convenient desktop icon with a link to the run action, or do a \textit{Desktop Integration} manually or with external programs.
45 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.
47 \begin{lstlisting}[style=sh]
48 sudo pacman -S libappimage
51 \section{Download Already Built \CGG{}}%
52 \label{sec:download_already_built_cinelerra_gg}
56 \includegraphics[width=1.0\linewidth]{download-distros.png}
57 \caption{Screencast of the website Download page for installing \CGG{} for various O/S.}
58 \label{fig:download-distros}
61 If you prefer to not have to take the time to build \CGG{} Infinity
62 yourself, there are pre-built dynamic or static binaries for various
63 versions of Ubuntu, Mint, Suse, Fedora, Debian, Centos, Arch, and
64 Slackware linux as well as Gentoo and FreeBSD. If you do want to build it yourself so that
65 you get the added benefit of the latest checked in changes, please reference
66 ~\ref{sec:How_to_build}.
68 A Windows 10 version installation is described in~\ref{sec:ms_windows10}. There are also 32-bit i686 Ubuntu, Debian,
69 and Slackware versions available. \textbf{These binaries are no longer being updated; they are stable and working but without future functionality}.
70 They are in subdirectories of:
73 \item \href{https://cinelerra-gg.org/download/tars}{https://cinelerra-gg.org/download/tars}
74 \item \href{https://cinelerra-gg.org/download/pkgs}{https://cinelerra-gg.org/download/pkgs}
77 The \textbf{tars} \index{tars} directory contains single-user static builds for
80 This is the recommended usage of \CGG{} because all of the files
81 will exist in a single directory. Generally all of the necessary
82 libraries are built into the static build, but in some cases you may
83 have to install another library that is being called for.
85 To install the single user builds, download the designated tarball
86 from the \texttt{./tars} subdirectory and unpack as indicated below:
88 \begin{lstlisting}[style=sh]
92 tar -xJf /src/path/cinelerra-5.1-*.txz # for the *, substitute your distro tarball name
95 \emph{Do not download the LEAP 10-bit version unless you specifically want to
96 use h265 rendering to 10-bit instead of the more standard 8-bit.} For more
97 information see ~\ref{sec:cinx_and_a_bit_of_confusion}.
99 The \textbf{pkgs} \index{pkgs} directory contains the standard packaged
100 application for various distros. This will install a dynamic
101 system version for users who prefer to have the binaries in the
102 system area and for multi-user systems.
104 In addition, performing the package install checks the md5sum in
105 the file \texttt{md5sum.txt} to ensure the channel correctly
106 transmits the package. There is a
107 \href{https://cinelerra-gg.org/download/README.pkgs}{README.pkgs}
108 file in the \texttt{download} directory with instructions so you
109 can \textit{cut and paste} and avoid typos; it is also shown
112 \lstset{inputpath=extra/}
115 basicstyle=\footnotesize,
116 caption={README.pkgs}
119 \section{How to Build \CGG{} from Developer's Git Repository}%
120 \label{sec:How_to_build}
124 These are generic build instructions for building \CGG{} Infinity.
125 Known to work on Ubuntu, Mint, OpenSuse, Fedora, Debian, Centos,
126 Arch, Slackware, and Gentoo. It has not been tested on every
127 single possible distro yet so you might expect to have to make
128 some minor changes. Also works on a somewhat limited basis on
129 FreeBSD and Windows 10 with the bsd.patch for FreeBSD and the
130 cygwin.patch for Windows 10.
132 NOTE: as of May 31, 2021 when Context Help was added, to include
133 this Context Help you will need to download the corresponding
134 tgz file containing the HTML manual sections referenced for the
135 Help pages. The file to download is:
136 \url{https://cinelerra-gg.org/download/images/HTML_Manual-20210531.tgz}
137 substituting for "20210531" the "yyyymmdd" representing latest release date.
138 Then unpack to your Cinelerra/bin/doc directory so it is included in
142 Alternatively, there are some pre-built dynamic or static binaries
143 which are updated on a fairly regular basis (as long as code changes
144 have been made) available at the link below.
146 \href{https://cinelerra-gg.org/download/}{https://cinelerra-gg.org/download/}
149 There are 2 kinds of builds, the default system-build and a
150 single-user build. A system build has results which are installed
151 to the system. The majority of the files are installed in the
152 standard system paths, but some customization is possible. The
153 single user build allows for running completely out of a local
154 user directory so it doesn't affect the system.
156 We recommend the single-user version when possible. It makes it
157 very easy to install a new version without having to delete the
158 older version in case you want it for backup -- once you are happy
159 with the new version, all you have to do is delete the entire old
160 directory path. Another reason for using single-user is that if
161 you install a new Operating System version and if you have \CGG{}
162 on separate disk space that is preserved, you won't have to
163 reinstall \CGG{}. It is also convenient for the purpose of having
164 the ability to interrupt or to see any possible error messages, if
165 you start the application from a terminal window command line
166 where you will have more control to catch problems. All that
167 said, the system builds can be useful in a university lab setting
168 where there are possibly multiple users, or multiple versions.
170 There are two notable differences between standard views
171 of \CGG{} and this implementation for the system builds. Both of
172 these can be configured during installation. The differences make
173 it possible to have several different versions installed without
174 having them interfere with each other.
177 \item application name can be set during a build but defaults
179 \item the home configuration directory can also be set and
180 traditionally defaults to: \texttt{\$HOME/.bcast5}
184 \subsection{The system build}
185 \label{sec:system-build}
188 To do a system build \index{build} , you should read the file
189 \texttt{README} that is at the top level after you get the source.
192 \item You need about 6.0 \,GB of disk storage to operate a build and
193 you need to have \textit{git} installed.
195 \item Obviously in order to install into the system, you must run as
198 \item The \textit{git:} step has to download many files (approx
199 130\,MB) so allow time. When decompressed this will expand to
202 \item Run the following commands (this takes awhile):
204 \begin{lstlisting}[style=sh]
205 # This is where you need the 6.0GB of disk space:
207 git clone --depth 1 "git://git.cinelerra-gg.org/goodguy/cinelerra.git" cinelerra5
208 # Change to the cloned directory:
209 cd cinelerra5/cinelerra-5.1
211 NOTE: if your system has never had \CGG{} Infinity installed, you
212 will have to make sure you have all of the compilers and libraries
213 necessary. So on the very first build you should run:
215 \begin{lstlisting}[style=sh]
216 ./blds/bld_prepare.sh <os> # where <os> represents the
217 # Operating System of
218 # centos, fedora, suse, ubuntu, mint, debian.
220 ./configure --prefix=/usr # optional parameters can be added here
221 make 2>&1 | tee log # make and log the build
224 \texttt{bld\_prepare.sh} does not work for Arch Linux or Gentoo,
225 so we have to install the dependencies
226 manually. \texttt{README.arch} or \texttt{README.gentoo}, which
227 contain the list of dependencies, can be found at:
229 \item \href{https://cinelerra-gg.org/download/README.arch}{https://cinelerra-gg.org/download/README.arch}
230 \item \href{https://cinelerra-gg.org/download/README.gentoo}{https://cinelerra-gg.org/download/README.gentoo}
233 \item Check for obvious build errors:
234 \begin{lstlisting}[style=sh]
235 grep "\*\*\*.*error" -ai log
237 If this reports errors and you need assistance or you think
238 improvements can be made to the builds, email the log which is
240 \href{mailto:cin@lists.cinelerra-gg.org}{cin@lists.cinelerra-gg.org}
241 \begin{lstlisting}[style=sh]
242 /<build_path>/cinelerra5/cinelerra-5.1/log
245 \item If there are no build errors, finally just run:
246 \begin{lstlisting}[style=sh]
249 Where <os> represents the Operating System supported by \CGG{}, such
250 as centos, fedora, suse, ubuntu, mint, debian.
251 The ``with-single-user'' parameter makes it so.
252 % Make and log build (
253 Check for errors before proceeding.
256 \item If it all worked, you are all setup. Just click on the \CGG{}
261 \subsection{The single-user build}
262 \label{sec:single-user-build}
263 \index{single-user build}
266 To do a single-user build, read the file \texttt{README} that is at
267 the top level after you get the source.
270 \item You need at least 6\,GB of disk storage to operate a build +
271 you need to have “\texttt{git}” installed.
273 \item Recommend you build and run as \textbf{root}, just to avoid
274 permission issues initially.
275 \item The \textit{git} step has to download many files (approx
276 130\,MB) so allow time.
278 \item Run the following commands (this takes awhile):
279 \begin{lstlisting}[style=sh]
280 # This is where you need the 6GB of disk space
282 git clone --depth 1 "git://git.cinelerra-gg.org/goodguy/cinelerra.git" cinelerra5
283 # Toplevel directory:
284 cd cinelerra5/cinelerra-5.1
288 NOTE: if your system has never had \CGG{} Infinity installed, you
289 will have to make sure all the compilers and libraries necessary are
290 installed. So on the very first build you should run as
293 % FIXME No novels in the listings.
294 \begin{lstlisting}[style=sh]
295 ./blds/bld_prepare.sh <os>
297 ./configure --with-single-user
301 Where <os> represents the Operating System supported by \CGG{}, such
302 as centos, fedora, suse, ubuntu, mint, debian.
303 The ``with-single-user'' parameter makes it so.
304 % Make and log build (
305 Check for errors before proceeding.
308 Then just start the application by keying in: \texttt{./cin} in the
309 bin subdirectory OR add a desktop icon by using the appropriate
310 directory to copy the files to, run as \textbf{root}, and edit to
311 correct the directory path. Below are generic directions of how to
314 Then just start the application by keying in: \texttt{./cin} in the
315 bin subdirectory OR add a desktop icon by using the appropriate
316 directory to copy the files to, run as \textbf{root}, and edit to
317 correct the directory path. Below are generic directions of how to
320 \begin{lstlisting}[style=sh]
321 cd /cinelerra_directory_path
322 cp -a image/cin.{svg,xpm} /usr/share/pixmaps/
323 cp -a image/cin.desktop /usr/share/applications/cin.desktop
326 After you have followed the above, in the cin.desktop file, change
327 the \texttt{Exec=cin} line to be
328 \texttt{Exec=<your\_directory\_path>/bin/cin}.
330 The preceding directions for doing a single-user build may work
331 without being root on some distros except for the \texttt{bld\_prepare.sh}
332 and creating the desktop icon. For example in Arch Linux installing without being root
333 works using the following steps:
335 \begin{lstlisting}[style=sh]
336 $ git clone --depth 1 "git://git.cinelerra-gg.org/goodguy/cinelerra.git" cinelerra5
337 $ cd /home/USER/cinelerra5/cinelerra-5.1
339 $ ./configure --prefix=/usr --with-single-user --with-booby
340 $ make 2>&1 | tee /tmp/cin5.log && make install
344 \subsection{Notable Options and Caveats}%
345 \label{sub:notable_options_and_caveats}
348 These procedures and the \CGG{} Infinity software have all been run
349 as \textbf{root} on various home laptops and desktops. This provides
350 the best chance to ensure all works correctly and also allows for
351 handling errors, other problems and potential crashes with the most
352 success. Included in this section are some of the build variations
353 easily available for normal builds.
355 To see the full list of features use:
357 \begin{lstlisting}[style=sh]
360 The default build \index{build} is a system build which uses:
362 \begin{lstlisting}[style=sh]
363 ./configure --without-single-user
366 In the single-user build \index{single-user build}, the target directory is always
367 \texttt{cin}. Because this is also the developer build, constant
368 names are used throughout. However, you can rename files after the
371 If your operating system has issues with the default install to
372 \texttt{/usr/local}, you might have to change the location to
373 \texttt{/usr} for a system build. Then you will have to use:
374 \begin{lstlisting}[style=sh]
375 ./configure --prefix=/usr
378 If you wish to change the default directory for a system build you
379 will have to add the destination directory path on the \texttt{make
380 install} line. For example:
381 \begin{lstlisting}[style=sh]
382 make install DESTDIR=<your selected target directory path>
385 The application name can be set during installation, but defaults to
386 \texttt{cin} so that the GG/Infinity build can coexist with other
387 \CGG{} builds if necessary. To override the default \texttt{cin}
389 \begin{lstlisting}[style=sh]
390 ./configure --with-exec-name=cinelerra
393 The home configuration directory can also be set, but default
394 location is traditionally \texttt{\$HOME/.bcast5}. For example:
396 \begin{lstlisting}[style=sh]
397 ./configure -with-config-dir=/myusername/.bcast5
400 NOTE: when you specify parameters to the configure program, it will
401 create a \texttt{make} file as a consequence. Since in a
402 \texttt{make} file, the \$ is a special character, it must be
403 escaped so in order to represent a \$ as part of an input parameter,
404 it has to be stuttered. That is, you will need \$\$ (2 dollar
405 signs) to represent a single dollar sign.
407 It may be necessary on some distros which have missing or incomplete
408 up-to-date libraries, to build \CGG{} without Ladspa. To do so,
411 \begin{lstlisting}[style=sh]
412 ./configure --prefix=/usr --without-ladspa-build
415 Note that the with-ladspa-dir is the ladspa search path, and
416 exists even if the ladspa build is not selected. This gives you
417 the ability to specify an alternate ladspa system path by
418 utilizing the \texttt{LADSPA\_PATH} environment variable (that is,
419 the default ladspa build is deselected).
421 Note for 32-bit 14.2 Slackware, Debian, Gentoo, Arch, FreeBSD,
422 before running the configure, you will need to set up the following:
424 \begin{lstlisting}[style=sh]
425 export ac_cv_header_xmmintrin_h=no
426 export FFMPEG_EXTRA_CFG=" --disable-vdpau"
429 NOTE: as of May 31, 2021 when Context Help was added, to include
430 this Context Help you will need to download the corresponding
431 tgz file containing the HTML manual sections referenced for the
432 Help pages. The file to download is:
433 \url{https://cinelerra-gg.org/download/images/HTML_Manual-20210531.tgz}
434 substituting for "20210531" the "yyyymmdd" representing latest release date.
435 Then unpack to your Cinelerra/bin/doc directory so it is included in
436 your built system. The reason for not including the HTML manual in
437 the source code so that it would already be there, is because it is
438 very large and has its own GIT base.
440 \subsection{Notes about Building from Git in your Customized Environment}%
441 \label{sub:notes_about_building_from_git_in_your_customized_environment}
446 Getting a build to work in a custom environment is not easy. If you
447 have already installed libraries which are normally in the
448 thirdparty build, getting them to be recognized means you have to
449 install the \textit{devel} version so the header files which match
450 the library interfaces exist. Below is the list of thirdparty
451 builds, but this list may have changed over time.
452 % It's list of Table?
456 \caption{List of thirdparty builds}
457 \label{tab:List_of_thirdparty_builds}
459 \begin{tabular}{m{8em}c}
503 The \textit{yes} means force build and \textit{auto} means probe and
504 use the system version if the build operation is not static. To get
505 your customized build to work, you need to change the probe options
506 for the conflicting libraries from \textit{yes} to \textit{auto}, or
507 even rework the \texttt{configure.ac} script. There may be several
508 libraries which need special treatment.
510 An example of a problem you might encounter with your customized
511 installation is with \texttt{a52dec} which has probes line
512 \texttt{(CHECK\_LIB/CHECK\_HEADERS)} in \texttt{configure.ac}, but
513 \texttt{djbfft} does not. In this case, \texttt{djbfft} is only
514 built because \texttt{a52dec} is built, so if your system has
515 \texttt{a52dec}, set \texttt{a52dec} to auto and see if that
516 problem is solved by retrying the build with:
517 \begin{lstlisting}[style=sh]
518 ./confgure --with-single-user -enable-a52dec=auto .
521 With persistence, you can get results, but it may take several tries
522 to stabilize the build. If you need help, email the \texttt{log}
523 and \texttt{config.log}, which is usually sufficient to determine
526 If you have already installed the \texttt{libfdk\_aac} development
527 package on your computer because you prefer this version over the
528 default aac, you will have to do the following to get this
529 alternative operational. The libfdk\_aac library is not a part of
530 \CGG{} by default because it is not license free.
532 \begin{lstlisting}[style=sh]
533 export FFMPEG_EXTRA_CFG=" --enable-libfdk-aac --enable-nonfree"
534 export EXTRA_LIBS=" -lfdk-aac"
535 for f in `grep -lw aac cinelerra-5.1/ffmpeg/audio/*`; do
536 sed -e 's/\<aac\>/libfdk_aac/' -i $f
541 \subsection{Cloning the Repository for Faster Updates}%
542 \label{sub:cloning_the_repository_for_faster_updates}
546 If you want to avoid downloading the software every time an update
547 is available you need to create a local ``repository'' or repo. The
548 repo is a directory where you first do a \texttt{git clone}. For
549 the initial git clone, set up a local area for the repository
550 storage, referred to as \texttt{<repo\_path>}. The \texttt{git
551 clone} creates a repo named \texttt{cin5} in the
552 \texttt{/<repo\_path>/} directory. This accesses about 530\,MB of
553 repo data, so the device has to have at least that available. The
554 repo path is always a perfect clone of the main repo.
557 \paragraph{Setting up the initial clone}%
558 \label{par:setting_up_the_initial_clone}
560 You may want to add ``\verb|--depth 1|'' before \texttt{cin5}
561 because this will clone faster and is smaller, but has no history.
563 \begin{lstlisting}[style=sh]
565 git clone "git://git.cinelerra-gg.org/goodguy/cinelerra" cin5
567 Cloning into "cin5"...
568 remote: Counting objects: 20032, done.
569 remote: Compressing objects: 100% (11647/11647), done.
570 remote: Total 20032 (delta 11333), reused 16632 (delta 8189)
571 Receiving objects: 100% (20032/20032), 395.29 MiB | 3.26 MiB/s, done.
572 Resolving deltas: 100% (11333/11333), done.
573 Checking connectivity... done.
577 \paragraph{Update an existing repo}%
578 \label{par:update_an_existing_repo}
579 The below shows how you can get updates.
581 \begin{lstlisting}[style=sh]
587 \paragraph{Useful git commands}%
588 \label{par:useful_git_commands}
589 Some other commands that are useful.
591 \begin{lstlisting}[style=sh]
592 git clone "git://git.cinelerra-gg.org/goodguy/cinelerra.git" cin5
593 git pull # pull remote changes to the local version
594 git status # shows changed files
595 git clean -i # interactive clean, use answer 1 to "clean"
599 \subsection{How to Build from a Previous GIT Version}%
600 \label{sub:how_to_build_from_a_previous_git_version}
605 If you have a problem with the current GIT version, you can revert
606 to a previous working version easily. The commands to use will be
607 similar to these next lines which are then explained in more detail.
610 \begin{lstlisting}[style=sh]
611 cd /<path>/cin5 # substitute your repo path name for cin5
612 git log # shows a list of versions depending on history depth specification
613 git checkout <version> # choose a version number as listed
616 The \texttt{git log} command produces a log file with hash values
617 for commit keys to the level specifed if the the depth paramter
619 The hash ids are the commit names to use when you
620 use git checkout. Next is displayed sample output:
622 \begin{lstlisting}[style=nil]
623 delete stray line in last checkin
625 commit 4a90ef3ae46465c0634f81916b79e279e4bd9961
626 Author: Good Guy <good1.2guy@gmail.com>
627 Date: Thu Feb 22 14:56:45 2018 -0700
629 nested clips, big rework and cleanup, sams new icons,
632 commit f87479bd556ea7db4afdd02297fc00977412b873
633 Author: Good Guy <good1.2guy@gmail.com>
634 Date: Sat Feb 17 18:09:22 2018 -0700
637 For the \texttt{git checkout <version>}, you would then keyin the
638 line below for the following results:
640 \begin{lstlisting}[style=nil]
641 git checkout f87479bd556ea7db4afdd02297fc00977412b873
643 Note: checking out 'f87479bd556ea7db4afdd02297fc00977412b873'.
645 You are in 'detached HEAD' state. You can look around, make
646 experimental changes and commit them, and you can discard any
647 commits you make in this state without impacting any branches by
648 performing another checkout.
650 If you want to create a new branch to retain commits you create,
651 you may do so (now or later) by using -b with the checkout command
654 git checkout -b <new-branch-name>
656 HEAD is now at f87479bd... more file size icon updates,
657 and more to followend
660 Later to get the repo back to current, use:
661 \begin{lstlisting}[style=sh]
666 \subsection{Debuggable Single User Build}%
667 \label{sub:debuggable_single_user_build}
668 \index{single-user build}
671 To build from source with full debugging symbols, first build a full
672 static (non\_debug) build as follows but instead of using
673 \texttt{/tmp} substitute your permanent disk path if you want to
676 \begin{lstlisting}[style=sh]
678 git clone --depth 1 "git://git.cinelerra-gg.org/goodguy/cinelerra.git" cinelerra5
679 cp -a /<repo_path>/cinelerra-5.1 /tmp/
680 cd /tmp/cinelerra-5.1
684 Then, to run as a developer in the debugger:
686 \begin{lstlisting}[style=sh]
687 CFLAGS="-O2 -ggdb" make -j8 rebuild_all
693 \subsection{Unbundled Builds}%
694 \label{sub:unbundled_builds}
699 There are some generic build scripts included in the \CGG{} GIT
700 repository for users who want to do unbundled builds with ffmpeg
701 already available on their system. This has been tested on Arch,
702 Ubuntu 18, FreeBSD, Windows10 and Leap 15 (rpm) at the time this
705 The names of the build scripts are: \texttt{arch.bld},
706 \texttt{bsd.bld}, \texttt{deb.bld}, \texttt{rpm.bld}, and
707 \texttt{cygwin.bld}. These scripts are in the \texttt{blds}
708 subdirectory. The \texttt{bsd.bld} should be used with the
709 \texttt{bsd.patch} file in that same directory. The
710 \texttt{cygwin.bld} should be used with the \texttt{cygwin.patch}
711 file in that same directory.
713 The reason that Cin Infinity traditionally uses its own thirdparty builds
714 (bundled builds) is because there are a lot of different distros
715 with varying levels of ffmpeg and other needed thirdparty
716 libraries. However, some users prefer using their current system
717 baseline without another/different copy of ffmpeg.
719 With different levels of the user’s libraries, uncertainty,
720 potential instability, and unknown issues may come up while
721 running \CGG{} and this will make it, for all practical purposes,
722 impossible to diagnose and debug problems or crashes.
724 There may be no help in these cases. You are encouraged to report
725 any errors which potentially originate from Cin Infinity, but if
726 the data indicates alternate library sources, please report the
727 problems to the appropriate maintainers.
729 With the unbundled builds, some features may not be available and
730 no attempt to comment them out has been made. So if you use a
731 pulldown, or pick a render option, or choose something that is not
732 available, it just will not work. For example, unless special
733 options were set up by you, the LV2 audio plugins will not be
734 available. Nor will the codec libzmpeg, the file codec ac3, or
735 DVD creation. The old school file classes will all work, but some
736 of the formats that come with ffmpeg may not because of the way
737 that ffmpeg was installed on your operating system. That is
738 because the \CGG{} included ffmpeg is a known static build and is
739 usually the latest stable/released version. For example, in the
740 current case of Leap 15, libx264 and libx265 are not built in and
741 this can be debilitating; you can always run \texttt{ffmpeg
742 -formats} and \texttt{ffmpeg -codecs} to see what is available
745 \section{Building the HTML Manual for Context Help}%
746 \label{sec:building_the_manual}
749 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 "2021.2" in order to create the html manual version from the latex.
751 The steps are as follows:
753 \item Download the manual in LaTeX:
755 \begin{lstlisting}[style=sh]
756 git clone "git://git.cinelerra-gg.org/goodguy/cin-manual-latex.git" master
759 \item Included in the download is the \textit{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):
760 \begin{lstlisting}[style=sh]
764 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 \textit{translate\_manual} script produce the PDF document from latex source which includes invoking makeindex for the Index and Glossary.
766 \begin{lstlisting}[style=sh]
767 pdflatex CinelerraGG_Manual.tex
768 makeindex CinelerraGG_Manual.idx
769 pdflatex CinelerraGG_Manual.tex
770 makeindex CinelerraGG_Manual.nlo -s nomencl.ist -o CinelerraGG_Manual.nls
771 pdflatex CinelerraGG_Manual.tex
774 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.
776 \item Next, to produce HTML output the script then moves (renames) latex2html-init to .latex2html-init (starting with dot).
778 \item Finally latex2html is run with a unique set of parameters and some cleanup is performed. The script uses latex2html. It creates the directory CinelerraGG\_Manual containing all the files of the manual in html: tables, references, index, glossary, and various images.
780 \item After installation of the \CGG{} program, place the complete unchanged directory CinelerraGG\_Manual, as it was produced by latex2html from the manual package, into the 'doc' directory of the installed Cinelerra package. This will be the directory bin/doc/CinelerraGG\_Manual if \CGG{} was built --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.
782 \item Optionally you can make some adjustments to the latex2html command line in the \textit{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.
785 \section{Windows 10 with Cygwin for \CGG{} Limited}%
786 \label{sec:ms_windows10}
789 To run \CGG{} on a Windows 10 computer, you will need to have
790 Cygwin installed on your system, along with the \CGG{} static tar
791 and a patched library: libxcb. This setup has been tested with
792 Windows 10, version 1909, on an HP EliteBook 820 at 2.3 GHz.
794 This limited version provides \textit{core} functionality at this
795 time with the standard Windows FFmpeg executable, meaning that
796 specific modifications in FFmpeg needed for \CGG{} are not
797 available. Limited capabilities include only a few render output
798 formats available - for example \textit{mov}, \textit{qt} as
799 \textit{mjpeg}, and \textit{mpeg} for videos and \textit{avi} and
800 \textit{qt} as \textit{s16le} for audio, but not \textit{mkv} or
801 \textit{mp4}. This is due to the fact that several codec and
802 utility libraries are not currently compiled to work with Windows.
804 \subsection*{Installing Cygwin}
805 \label{sec:installing_cygwin}
808 Cygwin is an environment that runs natively on Windows which
809 allows Unix programs to be compiled and run on Windows. With
810 cygwin installed on your Windows 10 computer, you will be able to
811 run \CGG{}. Before installing cygwin, you need to be warned that
812 the Avast anti-virus software kills files necessary for cygwin
813 installation and execution, so you will have to remove it and use
814 alternative anti-virus software (the standard default already
815 included with Windows 10 is Defender). Below are the steps for
819 \item Download cygwin for your 64-bit computer at:
820 \href{https://www.cygwin.com/}{https://www.cygwin.com/}
822 \item Generally just take the defaults as they show up, but the
823 next steps show what comes up.
825 \item When a warning window pops up, click \textit{Yes}.
827 \item Click \textit{Next}.
829 \item Choose \textit{Install from Internet} option and then click
832 \item Choose your desired directory by clicking on Browse
833 button. Choose \textit{All Users (Recommended)} and then click
836 \item Choose the local package directory where you would like your
837 installation files to be placed. Click \textit{Next}.
839 \item Choose \textit{Direct Connection} if you are using Internet
840 with plug and play device. Click \textit{Next}.
842 \item Choose any download site preferably
843 ``cygwin.mirror.constant.com'' and then click \textit{Next}.
845 \item For list of things to install, leave all set to
846 \textit{Default} except these to \textit{Install} instead:
855 This install takes a long time; approximately 2 hours on an
856 EliteBook and requires approximately 20GB storage.
858 \item Finally you will want to have the icons on your desktop
859 (already default) and then click \textit{Finish}.
862 Then to install the \CGG{} tar files, you will need to start a
863 cygwin console terminal from the startup menu as shown here:
864 \texttt{Start $\rightarrow$ Cygwin $\rightarrow$ Cygwin64}
867 \subsection*{Installing \CGG{}}
868 \label{sec:installing_cinelerra}
871 \item Download the tar file
872 \href{https://cinelerra-gg.org/download/testing/libxcb-bld.tar.bz2}{libxcb-bld.tar.bz2}.
874 \item Install libxcb from the tar file -- installs into
875 \texttt{/usr/local} and requires approximately 21MB storage.
876 \begin{lstlisting}[style=sh]
877 tar -C /usr/local -xJf /path/libxcb-bld.tar.bz2
879 The libxcb patch repairs an error (XIOError), which stops
882 \item Download the tar file
883 \href{https://cinelerra-gg.org/download/testing/cygcin-bld.tar.bz2}{cygcin-bld.tar.bz2}.
885 \item Install cygcin from the tar file - this installs into home
886 directory. Note this is cygcin \emph{not} cygwin. You must change the
887 \texttt{path} below to the name of the path where you downloaded
889 \begin{lstlisting}[style=sh]
891 tar -xJf /path/cygcin-bld.tar.bz2
895 This creates \texttt{\~{}/cygcin}, a user build installation of
896 \CGG{} and requires approximately 400MB storage.
898 \paragraph{Running \CGG{}:}
899 You will need to start a cygwin desktop from the startup menu:
901 \item \texttt{Start$\rightarrow$ Cygwin-X $\rightarrow$ Openbox}
903 You should start a console controlling terminal so that you can
906 \item \texttt{Start$\rightarrow$ Cygwin $\rightarrow$ Cygwin64} Terminal
908 This opens a separate window that can survive a cygwin hang and
909 bugs. Without these logs, it is much more difficult to use.
911 \item Type into that console controlling window, the following:
912 \begin{lstlisting}[style=sh]
916 \item Change directories to where \CGG{} is installed:
917 \begin{lstlisting}[style=sh]
918 cd /path/cygcin (NOT cygwin)
922 \begin{lstlisting}[style=sh]
925 which starts up your 4 \CGG{} windows.
928 The most noticeable difference from the Linux versions is that
929 \CGG{} seems to run very slowly on Windows 10. You must be very
930 tolerant and patient to see this work. It can however exhibit
931 astonishing speed when encoding. \CGG{} has to be downgraded
932 significantly due to lack of supported interfaces, codecs (for
933 example h264/h265), and utilities. The only graphics driver is
934 X11 and the only sound driver is pulseaudio. Almost all
935 configurable omissions are applied to this build.
937 \paragraph{\CGG{} build on cygwin from source code:}
940 \item Download and install ffmpeg into /usr/local :
942 download ffmpeg (currently 4.2.2)
943 \begin{lstlisting}[style=sh]
945 tar -xJf /path/ffmpeg-4.2.2.tar.bz2
952 \item Download and install a patched libxcb:
953 \begin{lstlisting}[style=sh]
956 tar -xf /path/libxcb-1.13.tar.bz2
958 patch -p1 < /path/cinelerra-5.1/thirdparty/src/libxcb.patch1
959 patching file configure.ac
960 patching file src/xcb_in.c
966 \item Download cinelerra-gg:
967 \begin{lstlisting}[style=sh]
969 git clone "git://git.cinelerra-gg.org/goodguy/cinelerra.git"
970 cd cinelerra-gg/cinelerra-5.1
972 \item Apply cygwin patch:
973 \begin{lstlisting}[style=sh]
974 patch -p2 < blds/cygwin.patch
976 \item Run the build with:
977 \begin{lstlisting}[style=sh]
982 This produces a directory: /build\_path/cinelerra-gg/cinelerra-5.1/bin
983 which is used to create the cygcin archive.
985 Currently, the targets are not stripped and can be run from gdb.
986 There is only very limited signal handler dmp file support.
987 Running gdb from inside a desktop resident console (not a cygwin64
988 window) will hang cygwin (and cin) when it hits a breakpoint. You
989 must run from an external console window to avoid this issue.
992 \section{Distro with \CGG{} Included}%
993 \label{sec:distro_with_cinelerra_included}
996 There are also some special complete distribution systems
997 available that include \CGG{} for audio and video production
1000 \subsection{AV Linux}
1001 \label{sec:AV_Linux}
1003 \textbf{AV Linux} is a downloadable/installable shared snapshot
1004 ISO image based on MX Linux. It provides the user an easy method to
1005 get an Audio and Video production workstation without the hassle
1006 of trying to find and install all of the usual components
1007 themselves. Of course, it includes \CGG{}!
1010 \href{http://www.bandshed.net/avlinux/}{homepage of AV Linux}.
1012 \subsection{Bodhi Linux Media}
1013 \label{sec:Bodhi_Linux}
1015 \textbf{Bodhi Linux Media} is a free and open source distribution that
1016 comes with a curated list of open source software for digital
1017 artists who work with audio, video, includes \CGG{}, games,
1018 graphics, animations, physical computing, etc.
1021 \href{https://gitlab.com/giuseppetorre/bodhilinuxmedia}{homepage of Bodhi Linux}.
1023 \subsection{DeLinuxCo}
1024 \label{sec:delinuxco}
1026 \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{}.
1028 You can read all about DeLinuxCo \href{https://www.delinuxco.com/}{here} and download \href{https://www.delinuxco.com/download/}{here}.
1033 \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.
1035 Click \href{https://www.elivecd.org/}{Elive} for more information. The \CGG{} package is at
1036 \href{http://repository.elivecd.org/pool/multimedia/c/cinelerra-gg/} {package} - just download
1037 the .deb file and install via “dpkg -i “. To include access to the Alt/h hotkey help, also install
1038 \href{http://repository.elivecd.org/pool/multimedia/c/cinelerra-gg-manual/}{manual} for help.
1040 \section{Cinx and a “Bit” of Confusion}%
1041 \label{sec:cinx_and_a_bit_of_confusion}
1044 Cinx is the exact same program as Cin. The X (x) represents the
1045 roman numeral 10 for 10-bit as opposed to 8-bit standard. The
1046 third-party library used for x265 must be specially compiled with
1047 \texttt{--bit-depth=10} in order to produce 10-bit rendered
1048 output. A cinx version can be built for most other distros if
1049 rendering at 10-bit is desirable instead of 8-bit.
1051 This build will not be able to output 8-bit depth which means you
1052 have to retain the Cin version also.
1054 Whatever build ffmpeg is linked to will determine what bit depth
1055 it can output. This is why there have to be separate builds. If
1056 you install both packages, Cin and CinX, you may get \textit{file
1057 conflicts of same file name} --- just continue.
1059 Keep in mind that the regular 8-bit version works on 8-bit bytes
1060 --- the standard word size for computers, but the 10-bit version
1061 has to use 2 words to contain all 10 bits so you can expect
1062 rendering to be as much as twice as slow.
1064 There is also a 12-bit version for consideration but currently the
1065 results are simply the same as 10-bit with padding to make 12-bit
1066 so it is of no value.
1069 %%% Local Variables:
1071 %%% TeX-master: "../CinelerraGG_Manual"