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. There is a
46 description of a GUI methodology for doing so in this file on the webiste:
48 \url{https://cinelerra-gg.org/download/images/README\_appimage.txt}
50 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.
52 \begin{lstlisting}[style=sh]
53 sudo pacman -S libappimage
56 And Leap 15.3 (OpenSUSE) requires installation of the \textit{appimage} package.
58 \begin{lstlisting}[style=sh]
59 sudo zypper se -is appimage
62 \section{Download Already Built \CGG{}}%
63 \label{sec:download_already_built_cinelerra_gg}
67 \includegraphics[width=1.0\linewidth]{download-distros.png}
68 \caption{Screencast of the website Download page for installing \CGG{} for various O/S.}
69 \label{fig:download-distros}
72 If you prefer to not have to take the time to build \CGG{} Infinity
73 yourself, there are pre-built dynamic or static binaries for various
74 versions of Ubuntu, Mint, Suse, Fedora, Debian, Centos, Arch, and
75 Slackware linux as well as Gentoo and FreeBSD. If you do want to build it yourself so that
76 you get the added benefit of the latest checked in changes, please reference
77 ~\ref{sec:How_to_build}.
79 A Windows 10 version installation is described in~\ref{sec:ms_windows10}. There are also 32-bit i686 Ubuntu, Debian,
80 and Slackware versions available. \textbf{These binaries are no longer being updated; they are stable and working but without future functionality}.
81 They are in subdirectories of:
84 \item \href{https://cinelerra-gg.org/download/tars}{https://cinelerra-gg.org/download/tars}
85 \item \href{https://cinelerra-gg.org/download/pkgs}{https://cinelerra-gg.org/download/pkgs}
88 The \textbf{tars} \index{tars} directory contains single-user static builds for
91 This is the recommended usage of \CGG{} because all of the files
92 will exist in a single directory. Generally all of the necessary
93 libraries are built into the static build, but in some cases you may
94 have to install another library that is being called for.
96 To install the single user builds, download the designated tarball
97 from the \texttt{./tars} subdirectory and unpack as indicated below:
99 \begin{lstlisting}[style=sh]
103 tar -xJf /src/path/cinelerra-5.1-*.txz # for the *, substitute your distro tarball name
106 \emph{Do not download the LEAP 10-bit version unless you specifically want to
107 use h265 rendering to 10-bit instead of the more standard 8-bit.} For more
108 information see ~\ref{sec:cinx_and_a_bit_of_confusion}.
110 The \textbf{pkgs} \index{pkgs} directory contains the standard packaged
111 application for various distros. This will install a dynamic
112 system version for users who prefer to have the binaries in the
113 system area and for multi-user systems.
115 In addition, performing the package install checks the md5sum in
116 the file \texttt{md5sum.txt} to ensure the channel correctly
117 transmits the package. There is a
118 \href{https://cinelerra-gg.org/download/README.pkgs}{README.pkgs}
119 file in the \texttt{download} directory with instructions so you
120 can \textit{cut and paste} and avoid typos; it is also shown
123 \lstset{inputpath=extra/}
126 basicstyle=\footnotesize,
127 caption={README.pkgs}
130 \section{How to Build \CGG{} from Developer's Git Repository}%
131 \label{sec:How_to_build}
135 These are generic build instructions for building \CGG{} Infinity.
136 Known to work on Ubuntu, Mint, OpenSuse, Fedora, Debian, Centos,
137 Arch, Slackware, and Gentoo. It has not been tested on every
138 single possible distro yet so you might expect to have to make
139 some minor changes. Also works on a somewhat limited basis on
140 FreeBSD and Windows 10 with the bsd.patch for FreeBSD and the
141 cygwin.patch for Windows 10.
143 NOTE: as of May 31, 2021 when Context Help was added, to include
144 this Context Help you will need to download the corresponding
145 tgz file containing the HTML manual sections referenced for the
146 Help pages. The file to download is:
147 \url{https://cinelerra-gg.org/download/images/HTML_Manual-20210531.tgz}
148 substituting for "20210531" the "yyyymmdd" representing latest release date.
149 Then unpack to your Cinelerra/bin/doc directory so it is included in
153 Alternatively, there are some pre-built dynamic or static binaries
154 which are updated on a fairly regular basis (as long as code changes
155 have been made) available at the link below.
157 \href{https://cinelerra-gg.org/download/}{https://cinelerra-gg.org/download/}
160 There are 2 kinds of builds, the default system-build and a
161 single-user build. A system build has results which are installed
162 to the system. The majority of the files are installed in the
163 standard system paths, but some customization is possible. The
164 single user build allows for running completely out of a local
165 user directory so it doesn't affect the system.
167 We recommend the single-user version when possible. It makes it
168 very easy to install a new version without having to delete the
169 older version in case you want it for backup -- once you are happy
170 with the new version, all you have to do is delete the entire old
171 directory path. Another reason for using single-user is that if
172 you install a new Operating System version and if you have \CGG{}
173 on separate disk space that is preserved, you won't have to
174 reinstall \CGG{}. It is also convenient for the purpose of having
175 the ability to interrupt or to see any possible error messages, if
176 you start the application from a terminal window command line
177 where you will have more control to catch problems. All that
178 said, the system builds can be useful in a university lab setting
179 where there are possibly multiple users, or multiple versions.
181 There are two notable differences between standard views
182 of \CGG{} and this implementation for the system builds. Both of
183 these can be configured during installation. The differences make
184 it possible to have several different versions installed without
185 having them interfere with each other.
188 \item application name can be set during a build but defaults
190 \item the home configuration directory can also be set and
191 traditionally defaults to: \texttt{\$HOME/.bcast5}
195 \subsection{The system build}
196 \label{sec:system-build}
199 To do a system build \index{build} , you should read the file
200 \texttt{README} that is at the top level after you get the source.
203 \item You need about 6.0 \,GB of disk storage to operate a build and
204 you need to have \textit{git} installed.
206 \item Obviously in order to install into the system, you must run as
209 \item The \textit{git:} step has to download many files (approx
210 130\,MB) so allow time. When decompressed this will expand to
213 \item Run the following commands (this takes awhile):
215 \begin{lstlisting}[style=sh]
216 # This is where you need the 6.0GB of disk space:
218 git clone --depth 1 "git://git.cinelerra-gg.org/goodguy/cinelerra.git" cinelerra5
219 # Change to the cloned directory:
220 cd cinelerra5/cinelerra-5.1
222 NOTE: if your system has never had \CGG{} Infinity installed, you
223 will have to make sure you have all of the compilers and libraries
224 necessary. So on the very first build you should run:
226 \begin{lstlisting}[style=sh]
227 ./blds/bld_prepare.sh <os> # where <os> represents the
228 # Operating System of
229 # centos, fedora, suse, ubuntu, mint, debian.
231 ./configure --prefix=/usr # optional parameters can be added here
232 make 2>&1 | tee log # make and log the build
235 \texttt{bld\_prepare.sh} does not work for Arch Linux or Gentoo,
236 so we have to install the dependencies
237 manually. \texttt{README.arch} or \texttt{README.gentoo}, which
238 contain the list of dependencies, can be found at:
240 \item \href{https://cinelerra-gg.org/download/README.arch}{https://cinelerra-gg.org/download/README.arch}
241 \item \href{https://cinelerra-gg.org/download/README.gentoo}{https://cinelerra-gg.org/download/README.gentoo}
244 \item Check for obvious build errors:
245 \begin{lstlisting}[style=sh]
246 grep "\*\*\*.*error" -ai log
248 If this reports errors and you need assistance or you think
249 improvements can be made to the builds, email the log which is
251 \href{mailto:cin@lists.cinelerra-gg.org}{cin@lists.cinelerra-gg.org}
252 \begin{lstlisting}[style=sh]
253 /<build_path>/cinelerra5/cinelerra-5.1/log
256 \item If there are no build errors, finally just run:
257 \begin{lstlisting}[style=sh]
260 Where <os> represents the Operating System supported by \CGG{}, such
261 as centos, fedora, suse, ubuntu, mint, debian.
262 The ``with-single-user'' parameter makes it so.
263 % Make and log build (
264 Check for errors before proceeding.
267 \item If it all worked, you are all setup. Just click on the \CGG{}
272 \subsection{The single-user build}
273 \label{sec:single-user-build}
274 \index{single-user build}
277 To do a single-user build, read the file \texttt{README} that is at
278 the top level after you get the source.
281 \item You need at least 6\,GB of disk storage to operate a build +
282 you need to have “\texttt{git}” installed.
284 \item Recommend you build and run as \textbf{root}, just to avoid
285 permission issues initially.
286 \item The \textit{git} step has to download many files (approx
287 130\,MB) so allow time.
289 \item Run the following commands (this takes awhile):
290 \begin{lstlisting}[style=sh]
291 # This is where you need the 6GB of disk space
293 git clone --depth 1 "git://git.cinelerra-gg.org/goodguy/cinelerra.git" cinelerra5
294 # Toplevel directory:
295 cd cinelerra5/cinelerra-5.1
299 NOTE: if your system has never had \CGG{} Infinity installed, you
300 will have to make sure all the compilers and libraries necessary are
301 installed. So on the very first build you should run as
304 % FIXME No novels in the listings.
305 \begin{lstlisting}[style=sh]
306 ./blds/bld_prepare.sh <os>
308 ./configure --with-single-user
312 Where <os> represents the Operating System supported by \CGG{}, such
313 as centos, fedora, suse, ubuntu, mint, debian.
314 The ``with-single-user'' parameter makes it so.
315 % Make and log build (
316 Check for errors before proceeding.
319 Then just start the application by keying in: \texttt{./cin} in the
320 bin subdirectory OR add a desktop icon by using the appropriate
321 directory to copy the files to, run as \textbf{root}, and edit to
322 correct the directory path. Below are generic directions of how to
325 Then just start the application by keying in: \texttt{./cin} in the
326 bin subdirectory OR add a desktop icon by using the appropriate
327 directory to copy the files to, run as \textbf{root}, and edit to
328 correct the directory path. Below are generic directions of how to
331 \begin{lstlisting}[style=sh]
332 cd /cinelerra_directory_path
333 cp -a image/cin.{svg,xpm} /usr/share/pixmaps/
334 cp -a image/cin.desktop /usr/share/applications/cin.desktop
337 After you have followed the above, in the cin.desktop file, change
338 the \texttt{Exec=cin} line to be
339 \texttt{Exec=<your\_directory\_path>/bin/cin}.
341 The preceding directions for doing a single-user build may work
342 without being root on some distros except for the \texttt{bld\_prepare.sh}
343 and creating the desktop icon. For example in Arch Linux installing without being root
344 works using the following steps:
346 \begin{lstlisting}[style=sh]
347 $ git clone --depth 1 "git://git.cinelerra-gg.org/goodguy/cinelerra.git" cinelerra5
348 $ cd /home/USER/cinelerra5/cinelerra-5.1
350 $ ./configure --prefix=/usr --with-single-user --with-booby
351 $ make 2>&1 | tee /tmp/cin5.log && make install
355 \subsection{Notable Options and Caveats}%
356 \label{sub:notable_options_and_caveats}
359 These procedures and the \CGG{} Infinity software have all been run
360 as \textbf{root} on various home laptops and desktops. This provides
361 the best chance to ensure all works correctly and also allows for
362 handling errors, other problems and potential crashes with the most
363 success. Included in this section are some of the build variations
364 easily available for normal builds.
366 To see the full list of features use:
368 \begin{lstlisting}[style=sh]
371 The default build \index{build} is a system build which uses:
373 \begin{lstlisting}[style=sh]
374 ./configure --without-single-user
377 In the single-user build \index{single-user build}, the target directory is always
378 \texttt{cin}. Because this is also the developer build, constant
379 names are used throughout. However, you can rename files after the
382 If your operating system has issues with the default install to
383 \texttt{/usr/local}, you might have to change the location to
384 \texttt{/usr} for a system build. Then you will have to use:
385 \begin{lstlisting}[style=sh]
386 ./configure --prefix=/usr
389 If you wish to change the default directory for a system build you
390 will have to add the destination directory path on the \texttt{make
391 install} line. For example:
392 \begin{lstlisting}[style=sh]
393 make install DESTDIR=<your selected target directory path>
396 The application name can be set during installation, but defaults to
397 \texttt{cin} so that the GG/Infinity build can coexist with other
398 \CGG{} builds if necessary. To override the default \texttt{cin}
400 \begin{lstlisting}[style=sh]
401 ./configure --with-exec-name=cinelerra
404 The home configuration directory can also be set, but default
405 location is traditionally \texttt{\$HOME/.bcast5}. For example:
407 \begin{lstlisting}[style=sh]
408 ./configure -with-config-dir=/myusername/.bcast5
411 NOTE: when you specify parameters to the configure program, it will
412 create a \texttt{make} file as a consequence. Since in a
413 \texttt{make} file, the \$ is a special character, it must be
414 escaped so in order to represent a \$ as part of an input parameter,
415 it has to be stuttered. That is, you will need \$\$ (2 dollar
416 signs) to represent a single dollar sign.
418 It may be necessary on some distros which have missing or incomplete
419 up-to-date libraries, to build \CGG{} without Ladspa. To do so,
422 \begin{lstlisting}[style=sh]
423 ./configure --prefix=/usr --without-ladspa-build
426 Note that the with-ladspa-dir is the ladspa search path, and
427 exists even if the ladspa build is not selected. This gives you
428 the ability to specify an alternate ladspa system path by
429 utilizing the \texttt{LADSPA\_PATH} environment variable (that is,
430 the default ladspa build is deselected).
432 Note for 32-bit 14.2 Slackware, Debian, Gentoo, Arch, FreeBSD,
433 before running the configure, you will need to set up the following:
435 \begin{lstlisting}[style=sh]
436 export ac_cv_header_xmmintrin_h=no
437 export FFMPEG_EXTRA_CFG=" --disable-vdpau"
440 NOTE: as of May 31, 2021 when Context Help was added, to include
441 this Context Help you will need to download the corresponding
442 tgz file containing the HTML manual sections referenced for the
443 Help pages. The file to download is:
444 \url{https://cinelerra-gg.org/download/images/HTML_Manual-20210531.tgz}
445 substituting for "20210531" the "yyyymmdd" representing latest release date.
446 Then unpack to your Cinelerra/bin/doc directory so it is included in
447 your built system. The reason for not including the HTML manual in
448 the source code so that it would already be there, is because it is
449 very large and has its own GIT base.
451 \subsection{Notes about Building from Git in your Customized Environment}%
452 \label{sub:notes_about_building_from_git_in_your_customized_environment}
457 Getting a build to work in a custom environment is not easy. If you
458 have already installed libraries which are normally in the
459 thirdparty build, getting them to be recognized means you have to
460 install the \textit{devel} version so the header files which match
461 the library interfaces exist. Below is the list of thirdparty
462 builds, but this list may have changed over time.
463 % It's list of Table?
467 \begin{longtable}{m{8em} c}
468 \caption{List of thirdparty builds}
469 \label{tab:List_of_thirdparty_builds}\\
512 The \textit{yes} means force build and \textit{auto} means probe and
513 use the system version if the build operation is not static. To get
514 your customized build to work, you need to change the probe options
515 for the conflicting libraries from \textit{yes} to \textit{auto}, or
516 even rework the \texttt{configure.ac} script. There may be several
517 libraries which need special treatment.
519 An example of a problem you might encounter with your customized
520 installation is with \texttt{a52dec} which has probes line
521 \texttt{(CHECK\_LIB/CHECK\_HEADERS)} in \texttt{configure.ac}, but
522 \texttt{djbfft} does not. In this case, \texttt{djbfft} is only
523 built because \texttt{a52dec} is built, so if your system has
524 \texttt{a52dec}, set \texttt{a52dec} to auto and see if that
525 problem is solved by retrying the build with:
526 \begin{lstlisting}[style=sh]
527 ./confgure --with-single-user -enable-a52dec=auto .
530 With persistence, you can get results, but it may take several tries
531 to stabilize the build. If you need help, email the \texttt{log}
532 and \texttt{config.log}, which is usually sufficient to determine
535 If you have already installed the \texttt{libfdk\_aac} development
536 package on your computer because you prefer this version over the
537 default aac, you will have to do the following to get this
538 alternative operational. The libfdk\_aac library is not a part of
539 \CGG{} by default because it is not license free.
541 \begin{lstlisting}[style=sh]
542 export FFMPEG_EXTRA_CFG=" --enable-libfdk-aac --enable-nonfree"
543 export EXTRA_LIBS=" -lfdk-aac"
544 for f in `grep -lw aac cinelerra-5.1/ffmpeg/audio/*`; do
545 sed -e 's/\<aac\>/libfdk_aac/' -i $f
550 \subsection{Cloning the Repository for Faster Updates}%
551 \label{sub:cloning_the_repository_for_faster_updates}
555 If you want to avoid downloading the software every time an update
556 is available you need to create a local ``repository'' or repo. The
557 repo is a directory where you first do a \texttt{git clone}. For
558 the initial git clone, set up a local area for the repository
559 storage, referred to as \texttt{<repo\_path>}. The \texttt{git
560 clone} creates a repo named \texttt{cin5} in the
561 \texttt{/<repo\_path>/} directory. This accesses about 530\,MB of
562 repo data, so the device has to have at least that available. The
563 repo path is always a perfect clone of the main repo.
566 \paragraph{Setting up the initial clone}%
567 \label{par:setting_up_the_initial_clone}
569 You may want to add ``\verb|--depth 1|'' before \texttt{cin5}
570 because this will clone faster and is smaller, but has no history.
572 \begin{lstlisting}[style=sh]
574 git clone "git://git.cinelerra-gg.org/goodguy/cinelerra" cin5
576 Cloning into "cin5"...
577 remote: Counting objects: 20032, done.
578 remote: Compressing objects: 100% (11647/11647), done.
579 remote: Total 20032 (delta 11333), reused 16632 (delta 8189)
580 Receiving objects: 100% (20032/20032), 395.29 MiB | 3.26 MiB/s, done.
581 Resolving deltas: 100% (11333/11333), done.
582 Checking connectivity... done.
586 \paragraph{Update an existing repo}%
587 \label{par:update_an_existing_repo}
588 The below shows how you can get updates.
590 \begin{lstlisting}[style=sh]
596 \paragraph{Useful git commands}%
597 \label{par:useful_git_commands}
598 Some other commands that are useful.
600 \begin{lstlisting}[style=sh]
601 git clone "git://git.cinelerra-gg.org/goodguy/cinelerra.git" cin5
602 git pull # pull remote changes to the local version
603 git status # shows changed files
604 git clean -i # interactive clean, use answer 1 to "clean"
608 \subsection{How to Build from a Previous GIT Version}%
609 \label{sub:how_to_build_from_a_previous_git_version}
614 If you have a problem with the current GIT version, you can revert
615 to a previous working version easily. The commands to use will be
616 similar to these next lines which are then explained in more detail.
619 \begin{lstlisting}[style=sh]
620 cd /<path>/cin5 # substitute your repo path name for cin5
621 git log # shows a list of versions depending on history depth specification
622 git checkout <version> # choose a version number as listed
625 The \texttt{git log} command produces a log file with hash values
626 for commit keys to the level specifed if the the depth paramter
628 The hash ids are the commit names to use when you
629 use git checkout. Next is displayed sample output:
631 \begin{lstlisting}[style=nil]
632 delete stray line in last checkin
634 commit 4a90ef3ae46465c0634f81916b79e279e4bd9961
635 Author: Good Guy <good1.2guy@gmail.com>
636 Date: Thu Feb 22 14:56:45 2018 -0700
638 nested clips, big rework and cleanup, sams new icons,
641 commit f87479bd556ea7db4afdd02297fc00977412b873
642 Author: Good Guy <good1.2guy@gmail.com>
643 Date: Sat Feb 17 18:09:22 2018 -0700
646 For the \texttt{git checkout <version>}, you would then keyin the
647 line below for the following results:
649 \begin{lstlisting}[style=nil]
650 git checkout f87479bd556ea7db4afdd02297fc00977412b873
652 Note: checking out 'f87479bd556ea7db4afdd02297fc00977412b873'.
654 You are in 'detached HEAD' state. You can look around, make
655 experimental changes and commit them, and you can discard any
656 commits you make in this state without impacting any branches by
657 performing another checkout.
659 If you want to create a new branch to retain commits you create,
660 you may do so (now or later) by using -b with the checkout command
663 git checkout -b <new-branch-name>
665 HEAD is now at f87479bd... more file size icon updates,
666 and more to followend
669 Later to get the repo back to current, use:
670 \begin{lstlisting}[style=sh]
675 \subsection{Debuggable Single User Build}%
676 \label{sub:debuggable_single_user_build}
677 \index{single-user build}
680 To build from source with full debugging symbols, first build a full
681 static (non\_debug) build as follows but instead of using
682 \texttt{/tmp} substitute your permanent disk path if you want to
685 \begin{lstlisting}[style=sh]
687 git clone --depth 1 "git://git.cinelerra-gg.org/goodguy/cinelerra.git" cinelerra5
688 cp -a /<repo_path>/cinelerra-5.1 /tmp/
689 cd /tmp/cinelerra-5.1
693 Then, to run as a developer in the debugger:
695 \begin{lstlisting}[style=sh]
696 CFLAGS="-O2 -ggdb" make -j8 rebuild_all
702 \subsection{Unbundled Builds}%
703 \label{sub:unbundled_builds}
708 There are some generic build scripts included in the \CGG{} GIT
709 repository for users who want to do unbundled builds with ffmpeg
710 already available on their system. This has been tested on Arch,
711 Ubuntu 18, FreeBSD, Windows10 and Leap 15 (rpm) at the time this
714 The names of the build scripts are: \texttt{arch.bld},
715 \texttt{bsd.bld}, \texttt{deb.bld}, \texttt{rpm.bld}, and
716 \texttt{cygwin.bld}. These scripts are in the \texttt{blds}
717 subdirectory. The \texttt{bsd.bld} should be used with the
718 \texttt{bsd.patch} file in that same directory. The
719 \texttt{cygwin.bld} should be used with the \texttt{cygwin.patch}
720 file in that same directory.
722 The reason that Cin Infinity traditionally uses its own thirdparty builds
723 (bundled builds) is because there are a lot of different distros
724 with varying levels of ffmpeg and other needed thirdparty
725 libraries. However, some users prefer using their current system
726 baseline without another/different copy of ffmpeg.
728 With different levels of the user’s libraries, uncertainty,
729 potential instability, and unknown issues may come up while
730 running \CGG{} and this will make it, for all practical purposes,
731 impossible to diagnose and debug problems or crashes.
733 There may be no help in these cases. You are encouraged to report
734 any errors which potentially originate from Cin Infinity, but if
735 the data indicates alternate library sources, please report the
736 problems to the appropriate maintainers.
738 With the unbundled builds, some features may not be available and
739 no attempt to comment them out has been made. So if you use a
740 pulldown, or pick a render option, or choose something that is not
741 available, it just will not work. For example, unless special
742 options were set up by you, the LV2 audio plugins will not be
743 available. Nor will the codec libzmpeg, the file codec ac3, or
744 DVD creation. The old school file classes will all work, but some
745 of the formats that come with ffmpeg may not because of the way
746 that ffmpeg was installed on your operating system. That is
747 because the \CGG{} included ffmpeg is a known static build and is
748 usually the latest stable/released version. For example, in the
749 current case of Leap 15, libx264 and libx265 are not built in and
750 this can be debilitating; you can always run \texttt{ffmpeg
751 -formats} and \texttt{ffmpeg -codecs} to see what is available
754 \section{Building the HTML Manual for Context Help}%
755 \label{sec:building_the_manual}
758 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.
760 The steps are as follows:
762 \item Download the manual in LaTeX:
764 \begin{lstlisting}[style=sh]
765 git clone "git://git.cinelerra-gg.org/goodguy/cin-manual-latex.git" master
768 \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):
769 \begin{lstlisting}[style=sh]
773 The steps that this script performs are as follows:
775 \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.
777 \begin{lstlisting}[style=sh]
778 pdflatex CinelerraGG_Manual.tex
779 makeindex CinelerraGG_Manual.idx
780 pdflatex CinelerraGG_Manual.tex
781 makeindex CinelerraGG_Manual.nlo -s nomencl.ist -o CinelerraGG_Manual.nls
782 pdflatex CinelerraGG_Manual.tex
785 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.
786 \item Next, to produce HTML output the script then moves (renames) \texttt{latex 2html-init} to \texttt{.latex2html-init} (starting with dot).
788 \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.
791 \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.
793 \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.
796 \section{Windows 10 with Cygwin for \CGG{} Limited}%
797 \label{sec:ms_windows10}
800 To run \CGG{} on a Windows 10 computer, you will need to have
801 Cygwin installed on your system, along with the \CGG{} static tar
802 and a patched library: libxcb. This setup has been tested with
803 Windows 10, version 1909, on an HP EliteBook 820 at 2.3 GHz.
805 This limited version provides \textit{core} functionality at this
806 time with the standard Windows FFmpeg executable, meaning that
807 specific modifications in FFmpeg needed for \CGG{} are not
808 available. Limited capabilities include only a few render output
809 formats available - for example \textit{mov}, \textit{qt} as
810 \textit{mjpeg}, and \textit{mpeg} for videos and \textit{avi} and
811 \textit{qt} as \textit{s16le} for audio, but not \textit{mkv} or
812 \textit{mp4}. This is due to the fact that several codec and
813 utility libraries are not currently compiled to work with Windows.
815 \subsection*{Installing Cygwin}
816 \label{sec:installing_cygwin}
819 Cygwin is an environment that runs natively on Windows which
820 allows Unix programs to be compiled and run on Windows. With
821 cygwin installed on your Windows 10 computer, you will be able to
822 run \CGG{}. Before installing cygwin, you need to be warned that
823 the Avast anti-virus software kills files necessary for cygwin
824 installation and execution, so you will have to remove it and use
825 alternative anti-virus software (the standard default already
826 included with Windows 10 is Defender). Below are the steps for
830 \item Download cygwin for your 64-bit computer at:
831 \href{https://www.cygwin.com/}{https://www.cygwin.com/}
833 \item Generally just take the defaults as they show up, but the
834 next steps show what comes up.
836 \item When a warning window pops up, click \textit{Yes}.
838 \item Click \textit{Next}.
840 \item Choose \textit{Install from Internet} option and then click
843 \item Choose your desired directory by clicking on Browse
844 button. Choose \textit{All Users (Recommended)} and then click
847 \item Choose the local package directory where you would like your
848 installation files to be placed. Click \textit{Next}.
850 \item Choose \textit{Direct Connection} if you are using Internet
851 with plug and play device. Click \textit{Next}.
853 \item Choose any download site preferably
854 ``cygwin.mirror.constant.com'' and then click \textit{Next}.
856 \item For list of things to install, leave all set to
857 \textit{Default} except these to \textit{Install} instead:
866 This install takes a long time; approximately 2 hours on an
867 EliteBook and requires approximately 20GB storage.
869 \item Finally you will want to have the icons on your desktop
870 (already default) and then click \textit{Finish}.
873 Then to install the \CGG{} tar files, you will need to start a
874 cygwin console terminal from the startup menu as shown here:
875 \texttt{Start $\rightarrow$ Cygwin $\rightarrow$ Cygwin64}
878 \subsection*{Installing \CGG{}}
879 \label{sec:installing_cinelerra}
882 \item Download the tar file
883 \href{https://cinelerra-gg.org/download/testing/libxcb-bld.tar.bz2}{libxcb-bld.tar.bz2}.
885 \item Install libxcb from the tar file -- installs into
886 \texttt{/usr/local} and requires approximately 21MB storage.
887 \begin{lstlisting}[style=sh]
888 tar -C /usr/local -xJf /path/libxcb-bld.tar.bz2
890 The libxcb patch repairs an error (XIOError), which stops
893 \item Download the tar file
894 \href{https://cinelerra-gg.org/download/testing/cygcin-bld.tar.bz2}{cygcin-bld.tar.bz2}.
896 \item Install cygcin from the tar file - this installs into home
897 directory. Note this is cygcin \emph{not} cygwin. You must change the
898 \texttt{path} below to the name of the path where you downloaded
900 \begin{lstlisting}[style=sh]
902 tar -xJf /path/cygcin-bld.tar.bz2
906 This creates \texttt{\~{}/cygcin}, a user build installation of
907 \CGG{} and requires approximately 400MB storage.
909 \paragraph{Running \CGG{}:}
910 You will need to start a cygwin desktop from the startup menu:
912 \item \texttt{Start$\rightarrow$ Cygwin-X $\rightarrow$ Openbox}
914 You should start a console controlling terminal so that you can
917 \item \texttt{Start$\rightarrow$ Cygwin $\rightarrow$ Cygwin64} Terminal
919 This opens a separate window that can survive a cygwin hang and
920 bugs. Without these logs, it is much more difficult to use.
922 \item Type into that console controlling window, the following:
923 \begin{lstlisting}[style=sh]
927 \item Change directories to where \CGG{} is installed:
928 \begin{lstlisting}[style=sh]
929 cd /path/cygcin (NOT cygwin)
933 \begin{lstlisting}[style=sh]
936 which starts up your 4 \CGG{} windows.
939 The most noticeable difference from the Linux versions is that
940 \CGG{} seems to run very slowly on Windows 10. You must be very
941 tolerant and patient to see this work. It can however exhibit
942 astonishing speed when encoding. \CGG{} has to be downgraded
943 significantly due to lack of supported interfaces, codecs (for
944 example h264/h265), and utilities. The only graphics driver is
945 X11 and the only sound driver is pulseaudio. Almost all
946 configurable omissions are applied to this build.
948 \paragraph{\CGG{} build on cygwin from source code:}
951 \item Download and install ffmpeg into /usr/local :
953 download ffmpeg (currently 4.2.2)
954 \begin{lstlisting}[style=sh]
956 tar -xJf /path/ffmpeg-4.2.2.tar.bz2
963 \item Download and install a patched libxcb:
964 \begin{lstlisting}[style=sh]
967 tar -xf /path/libxcb-1.13.tar.bz2
969 patch -p1 < /path/cinelerra-5.1/thirdparty/src/libxcb.patch1
970 patching file configure.ac
971 patching file src/xcb_in.c
977 \item Download cinelerra-gg:
978 \begin{lstlisting}[style=sh]
980 git clone "git://git.cinelerra-gg.org/goodguy/cinelerra.git"
981 cd cinelerra-gg/cinelerra-5.1
983 \item Apply cygwin patch:
984 \begin{lstlisting}[style=sh]
985 patch -p2 < blds/cygwin.patch
987 \item Run the build with:
988 \begin{lstlisting}[style=sh]
993 This produces a directory: /build\_path/cinelerra-gg/cinelerra-5.1/bin
994 which is used to create the cygcin archive.
996 Currently, the targets are not stripped and can be run from gdb.
997 There is only very limited signal handler dmp file support.
998 Running gdb from inside a desktop resident console (not a cygwin64
999 window) will hang cygwin (and cin) when it hits a breakpoint. You
1000 must run from an external console window to avoid this issue.
1003 \section{Distro with \CGG{} Included}%
1004 \label{sec:distro_with_cinelerra_included}
1005 \index{linux distro}
1007 There are also some special complete distribution systems
1008 available that include \CGG{} for audio and video production
1011 \subsection{AV Linux}
1012 \label{sec:AV_Linux}
1014 \textbf{AV Linux} is a downloadable/installable shared snapshot
1015 ISO image based on MX Linux. It provides the user an easy method to
1016 get an Audio and Video production workstation without the hassle
1017 of trying to find and install all of the usual components
1018 themselves. Of course, it includes \CGG{}!
1021 \href{http://www.bandshed.net/avlinux/}{homepage of AV Linux}.
1023 \subsection{Bodhi Linux Media}
1024 \label{sec:Bodhi_Linux}
1026 \textbf{Bodhi Linux Media} is a free and open source distribution that
1027 comes with a curated list of open source software for digital
1028 artists who work with audio, video, includes \CGG{}, games,
1029 graphics, animations, physical computing, etc.
1032 \href{https://gitlab.com/giuseppetorre/bodhilinuxmedia}{homepage of Bodhi Linux}.
1034 \subsection{DeLinuxCo}
1035 \label{sec:delinuxco}
1037 \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{}.
1039 You can read all about DeLinuxCo \href{https://www.delinuxco.com/}{here} and download \href{https://www.delinuxco.com/download/}{here}.
1044 \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.
1046 Click \href{https://www.elivecd.org/}{Elive} for more information. The \CGG{} package is at
1047 \href{http://repository.elivecd.org/pool/multimedia/c/cinelerra-gg/} {package} - just download
1048 the .deb file and install via “dpkg -i “. To include access to the Alt/h hotkey help, also install
1049 \href{http://repository.elivecd.org/pool/multimedia/c/cinelerra-gg-manual/}{manual} for help.
1051 \section{Cinx and a “Bit” of Confusion}%
1052 \label{sec:cinx_and_a_bit_of_confusion}
1055 Cinx is the exact same program as Cin. The X (x) represents the
1056 roman numeral 10 for 10-bit as opposed to 8-bit standard. The
1057 third-party library used for x265 must be specially compiled with
1058 \texttt{--bit-depth=10} in order to produce 10-bit rendered
1059 output. A cinx version can be built for most other distros if
1060 rendering at 10-bit is desirable instead of 8-bit.
1062 This build will not be able to output 8-bit depth which means you
1063 have to retain the Cin version also.
1065 Whatever build ffmpeg is linked to will determine what bit depth
1066 it can output. This is why there have to be separate builds. If
1067 you install both packages, Cin and CinX, you may get \textit{file
1068 conflicts of same file name} --- just continue.
1070 Keep in mind that the regular 8-bit version works on 8-bit bytes
1071 --- the standard word size for computers, but the 10-bit version
1072 has to use 2 words to contain all 10 bits so you can expect
1073 rendering to be as much as twice as slow.
1075 There is also a 12-bit version for consideration but currently the
1076 results are simply the same as 10-bit with padding to make 12-bit
1077 so it is of no value.
1079 \section{Multibit build for x265-8/10/12-bit}%
1080 \label{sec:multibit_build}
1083 To build a version that can handle 8 bit, or 10 bit, or 12 bit videos,
1084 a patch is provided in the \texttt{thirdparty} subdirectory that needs
1085 to be applied to do so. Be aware that the compile may take more time
1086 and seems to be about twice as long. To apply the required patch:
1088 \begin{lstlisting}[style=sh]
1089 cd /path/to/cinelerra-5.1/thirdparty
1090 patch < compile_multibit_X265.txt
1091 mv x265_3.5.patch* src/.
1093 Render formats \textit{h265-10bit} and \textit{h265-12bit} have been provided and will
1094 be operational after the applied patch is compiled in.
1096 %%% Local Variables:
1098 %%% TeX-master: "../CinelerraGG_Manual"