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
141 Alternatively, there are some pre-built dynamic or static binaries
142 which are updated on a fairly regular basis (as long as code changes
143 have been made) available at the link below.
145 \href{https://cinelerra-gg.org/download/}{https://cinelerra-gg.org/download/}
148 There are 2 kinds of builds, the default system-build and a
149 single-user build. A system build has results which are installed
150 to the system. The majority of the files are installed in the
151 standard system paths, but some customization is possible. The
152 single user build allows for running completely out of a local
153 user directory so it doesn't affect the system.
155 We recommend the single-user version when possible. It makes it
156 very easy to install a new version without having to delete the
157 older version in case you want it for backup -- once you are happy
158 with the new version, all you have to do is delete the entire old
159 directory path. Another reason for using single-user is that if
160 you install a new Operating System version and if you have \CGG{}
161 on separate disk space that is preserved, you won't have to
162 reinstall \CGG{}. It is also convenient for the purpose of having
163 the ability to interrupt or to see any possible error messages, if
164 you start the application from a terminal window command line
165 where you will have more control to catch problems. All that
166 said, the system builds can be useful in a university lab setting
167 where there are possibly multiple users, or multiple versions.
169 There are two notable differences between standard views
170 of \CGG{} and this implementation for the system builds. Both of
171 these can be configured during installation. The differences make
172 it possible to have several different versions installed without
173 having them interfere with each other.
176 \item application name can be set during a build but defaults
178 \item the home configuration directory can also be set and
179 traditionally defaults to: \texttt{\$HOME/.bcast5}
183 \subsection{The system build}
184 \label{sec:system-build}
187 To do a system build \index{build} , you should read the file
188 \texttt{README} that is at the top level after you get the source.
191 \item You need about 6.0 \,GB of disk storage to operate a build and
192 you need to have \textit{git} installed.
194 \item Obviously in order to install into the system, you must run as
197 \item The \textit{git:} step has to download many files (approx
198 130\,MB) so allow time. When decompressed this will expand to
201 \item Run the following commands (this takes awhile):
203 \begin{lstlisting}[style=sh]
204 # This is where you need the 6.0GB of disk space:
206 git clone --depth 1 "git://git.cinelerra-gg.org/goodguy/cinelerra.git" cinelerra5
207 # Change to the cloned directory:
208 cd cinelerra5/cinelerra-5.1
210 NOTE: if your system has never had \CGG{} Infinity installed, you
211 will have to make sure you have all of the compilers and libraries
212 necessary. So on the very first build you should run:
214 \begin{lstlisting}[style=sh]
215 ./blds/bld_prepare.sh <os> # where <os> represents the
216 # Operating System of
217 # centos, fedora, suse, ubuntu, mint, debian.
219 ./configure --prefix=/usr # optional parameters can be added here
220 make 2>&1 | tee log # make and log the build
223 \texttt{bld\_prepare.sh} does not work for Arch Linux or Gentoo,
224 so we have to install the dependencies
225 manually. \texttt{README.arch} or \texttt{README.gentoo}, which
226 contain the list of dependencies, can be found at:
228 \item \href{https://cinelerra-gg.org/download/README.arch}{https://cinelerra-gg.org/download/README.arch}
229 \item \href{https://cinelerra-gg.org/download/README.gentoo}{https://cinelerra-gg.org/download/README.gentoo}
232 \item Check for obvious build errors:
233 \begin{lstlisting}[style=sh]
234 grep "\*\*\*.*error" -ai log
236 If this reports errors and you need assistance or you think
237 improvements can be made to the builds, email the log which is
239 \href{mailto:cin@lists.cinelerra-gg.org}{cin@lists.cinelerra-gg.org}
240 \begin{lstlisting}[style=sh]
241 /<build_path>/cinelerra5/cinelerra-5.1/log
244 \item If there are no build errors, finally just run:
245 \begin{lstlisting}[style=sh]
248 Where <os> represents the Operating System supported by \CGG{}, such
249 as centos, fedora, suse, ubuntu, mint, debian.
250 The ``with-single-user'' parameter makes it so.
251 % Make and log build (
252 Check for errors before proceeding.
255 \item If it all worked, you are all setup. Just click on the \CGG{}
260 \subsection{The single-user build}
261 \label{sec:single-user-build}
262 \index{single-user build}
265 To do a single-user build, read the file \texttt{README} that is at
266 the top level after you get the source.
269 \item You need at least 6\,GB of disk storage to operate a build +
270 you need to have “\texttt{git}” installed.
272 \item Recommend you build and run as \textbf{root}, just to avoid
273 permission issues initially.
274 \item The \textit{git} step has to download many files (approx
275 130\,MB) so allow time.
277 \item Run the following commands (this takes awhile):
278 \begin{lstlisting}[style=sh]
279 # This is where you need the 6GB of disk space
281 git clone --depth 1 "git://git.cinelerra-gg.org/goodguy/cinelerra.git" cinelerra5
282 # Toplevel directory:
283 cd cinelerra5/cinelerra-5.1
287 NOTE: if your system has never had \CGG{} Infinity installed, you
288 will have to make sure all the compilers and libraries necessary are
289 installed. So on the very first build you should run as
292 % FIXME No novels in the listings.
293 \begin{lstlisting}[style=sh]
294 ./blds/bld_prepare.sh <os>
296 ./configure --with-single-user
300 Where <os> represents the Operating System supported by \CGG{}, such
301 as centos, fedora, suse, ubuntu, mint, debian.
302 The ``with-single-user'' parameter makes it so.
303 % Make and log build (
304 Check for errors before proceeding.
307 Then just start the application by keying in: \texttt{./cin} in the
308 bin subdirectory OR add a desktop icon by using the appropriate
309 directory to copy the files to, run as \textbf{root}, and edit to
310 correct the directory path. Below are generic directions of how to
313 Then just start the application by keying in: \texttt{./cin} in the
314 bin subdirectory OR add a desktop icon by using the appropriate
315 directory to copy the files to, run as \textbf{root}, and edit to
316 correct the directory path. Below are generic directions of how to
319 \begin{lstlisting}[style=sh]
320 cd /cinelerra_directory_path
321 cp -a image/cin.{svg,xpm} /usr/share/pixmaps/
322 cp -a image/cin.desktop /usr/share/applications/cin.desktop
325 After you have followed the above, in the cin.desktop file, change
326 the \texttt{Exec=cin} line to be
327 \texttt{Exec=<your\_directory\_path>/bin/cin}.
329 The preceding directions for doing a single-user build may work
330 without being root on some distros except for the \texttt{bld\_prepare.sh}
331 and creating the desktop icon. For example in Arch Linux installing without being root
332 works using the following steps:
334 \begin{lstlisting}[style=sh]
335 $ git clone --depth 1 "git://git.cinelerra-gg.org/goodguy/cinelerra.git" cinelerra5
336 $ cd /home/USER/cinelerra5/cinelerra-5.1
338 $ ./configure --prefix=/usr --with-single-user --with-booby
339 $ make 2>&1 | tee /tmp/cin5.log && make install
343 \subsection{Notable Options and Caveats}%
344 \label{sub:notable_options_and_caveats}
347 These procedures and the \CGG{} Infinity software have all been run
348 as \textbf{root} on various home laptops and desktops. This provides
349 the best chance to ensure all works correctly and also allows for
350 handling errors, other problems and potential crashes with the most
351 success. Included in this section are some of the build variations
352 easily available for normal builds.
354 To see the full list of features use:
356 \begin{lstlisting}[style=sh]
359 The default build \index{build} is a system build which uses:
361 \begin{lstlisting}[style=sh]
362 ./configure --without-single-user
365 In the single-user build \index{single-user build}, the target directory is always
366 \texttt{cin}. Because this is also the developer build, constant
367 names are used throughout. However, you can rename files after the
370 If your operating system has issues with the default install to
371 \texttt{/usr/local}, you might have to change the location to
372 \texttt{/usr} for a system build. Then you will have to use:
373 \begin{lstlisting}[style=sh]
374 ./configure --prefix=/usr
377 If you wish to change the default directory for a system build you
378 will have to add the destination directory path on the \texttt{make
379 install} line. For example:
380 \begin{lstlisting}[style=sh]
381 make install DESTDIR=<your selected target directory path>
384 The application name can be set during installation, but defaults to
385 \texttt{cin} so that the GG/Infinity build can coexist with other
386 \CGG{} builds if necessary. To override the default \texttt{cin}
388 \begin{lstlisting}[style=sh]
389 ./configure --with-exec-name=cinelerra
392 The home configuration directory can also be set, but default
393 location is traditionally \texttt{\$HOME/.bcast5}. For example:
395 \begin{lstlisting}[style=sh]
396 ./configure -with-config-dir=/myusername/.bcast5
399 NOTE: when you specify parameters to the configure program, it will
400 create a \texttt{make} file as a consequence. Since in a
401 \texttt{make} file, the \$ is a special character, it must be
402 escaped so in order to represent a \$ as part of an input parameter,
403 it has to be stuttered. That is, you will need \$\$ (2 dollar
404 signs) to represent a single dollar sign.
406 It may be necessary on some distros which have missing or incomplete
407 up-to-date libraries, to build \CGG{} without Ladspa. To do so,
410 \begin{lstlisting}[style=sh]
411 ./configure --prefix=/usr --without-ladspa-build
414 Note that the with-ladspa-dir is the ladspa search path, and
415 exists even if the ladspa build is not selected. This gives you
416 the ability to specify an alternate ladspa system path by
417 utilizing the \texttt{LADSPA\_PATH} environment variable (that is,
418 the default ladspa build is deselected).
420 Note for 32-bit 14.2 Slackware, Debian, Gentoo, Arch, FreeBSD,
421 before running the configure, you will need to set up the following:
423 \begin{lstlisting}[style=sh]
424 export ac_cv_header_xmmintrin_h=no
425 export FFMPEG_EXTRA_CFG=" --disable-vdpau"
428 NOTE: as of May 31, 2021 when Context Help was added, to include
429 this Context Help you will need to download the corresponding
430 tgz file containing the HTML manual sections referenced for the
431 Help pages. The file to download is:
432 \url{https://cinelerra-gg.org/download/images/HTML_Manual-20210531.tgz}
433 substituting for "20210531" the "yyyymmdd" representing latest release date.
434 Then unpack to your Cinelerra/bin/doc directory so it is included in
435 your built system. The reason for not including the HTML manual in
436 the source code so that it would already be there, is because it is
437 very large and has its own GIT base.
439 \subsection{Notes about Building from Git in your Customized Environment}%
440 \label{sub:notes_about_building_from_git_in_your_customized_environment}
445 Getting a build to work in a custom environment is not easy. If you
446 have already installed libraries which are normally in the
447 thirdparty build, getting them to be recognized means you have to
448 install the \textit{devel} version so the header files which match
449 the library interfaces exist. Below is the list of thirdparty
450 builds, but this list may have changed over time.
451 % It's list of Table?
455 \caption{List of thirdparty builds}
456 \label{tab:List_of_thirdparty_builds}
458 \begin{tabular}{m{8em}c}
502 The \textit{yes} means force build and \textit{auto} means probe and
503 use the system version if the build operation is not static. To get
504 your customized build to work, you need to change the probe options
505 for the conflicting libraries from \textit{yes} to \textit{auto}, or
506 even rework the \texttt{configure.ac} script. There may be several
507 libraries which need special treatment.
509 An example of a problem you might encounter with your customized
510 installation is with \texttt{a52dec} which has probes line
511 \texttt{(CHECK\_LIB/CHECK\_HEADERS)} in \texttt{configure.ac}, but
512 \texttt{djbfft} does not. In this case, \texttt{djbfft} is only
513 built because \texttt{a52dec} is built, so if your system has
514 \texttt{a52dec}, set \texttt{a52dec} to auto and see if that
515 problem is solved by retrying the build with:
516 \begin{lstlisting}[style=sh]
517 ./confgure --with-single-user -enable-a52dec=auto .
520 With persistence, you can get results, but it may take several tries
521 to stabilize the build. If you need help, email the \texttt{log}
522 and \texttt{config.log}, which is usually sufficient to determine
525 If you have already installed the \texttt{libfdk\_aac} development
526 package on your computer because you prefer this version over the
527 default aac, you will have to do the following to get this
528 alternative operational. The libfdk\_aac library is not a part of
529 \CGG{} by default because it is not license free.
531 \begin{lstlisting}[style=sh]
532 export FFMPEG_EXTRA_CFG=" --enable-libfdk-aac --enable-nonfree"
533 export EXTRA_LIBS=" -lfdk-aac"
534 for f in `grep -lw aac cinelerra-5.1/ffmpeg/audio/*`; do
535 sed -e 's/\<aac\>/libfdk_aac/' -i $f
540 \subsection{Cloning the Repository for Faster Updates}%
541 \label{sub:cloning_the_repository_for_faster_updates}
545 If you want to avoid downloading the software every time an update
546 is available you need to create a local ``repository'' or repo. The
547 repo is a directory where you first do a \texttt{git clone}. For
548 the initial git clone, set up a local area for the repository
549 storage, referred to as \texttt{<repo\_path>}. The \texttt{git
550 clone} creates a repo named \texttt{cin5} in the
551 \texttt{/<repo\_path>/} directory. This accesses about 530\,MB of
552 repo data, so the device has to have at least that available. The
553 repo path is always a perfect clone of the main repo.
556 \paragraph{Setting up the initial clone}%
557 \label{par:setting_up_the_initial_clone}
559 You may want to add ``\verb|--depth 1|'' before \texttt{cin5}
560 because this will clone faster and is smaller, but has no history.
562 \begin{lstlisting}[style=sh]
564 git clone "git://git.cinelerra-gg.org/goodguy/cinelerra" cin5
566 Cloning into "cin5"...
567 remote: Counting objects: 20032, done.
568 remote: Compressing objects: 100% (11647/11647), done.
569 remote: Total 20032 (delta 11333), reused 16632 (delta 8189)
570 Receiving objects: 100% (20032/20032), 395.29 MiB | 3.26 MiB/s, done.
571 Resolving deltas: 100% (11333/11333), done.
572 Checking connectivity... done.
576 \paragraph{Update an existing repo}%
577 \label{par:update_an_existing_repo}
578 The below shows how you can get updates.
580 \begin{lstlisting}[style=sh]
586 \paragraph{Useful git commands}%
587 \label{par:useful_git_commands}
588 Some other commands that are useful.
590 \begin{lstlisting}[style=sh]
591 git clone "git://git.cinelerra-gg.org/goodguy/cinelerra.git" cin5
592 git pull # pull remote changes to the local version
593 git status # shows changed files
594 git clean -i # interactive clean, use answer 1 to "clean"
598 \subsection{How to Build from a Previous GIT Version}%
599 \label{sub:how_to_build_from_a_previous_git_version}
604 If you have a problem with the current GIT version, you can revert
605 to a previous working version easily. The commands to use will be
606 similar to these next lines which are then explained in more detail.
609 \begin{lstlisting}[style=sh]
610 cd /<path>/cin5 # substitute your repo path name for cin5
611 git log # shows a list of versions depending on history depth specification
612 git checkout <version> # choose a version number as listed
615 The \texttt{git log} command produces a log file with hash values
616 for commit keys to the level specifed if the the depth paramter
618 The hash ids are the commit names to use when you
619 use git checkout. Next is displayed sample output:
621 \begin{lstlisting}[style=nil]
622 delete stray line in last checkin
624 commit 4a90ef3ae46465c0634f81916b79e279e4bd9961
625 Author: Good Guy <good1.2guy@gmail.com>
626 Date: Thu Feb 22 14:56:45 2018 -0700
628 nested clips, big rework and cleanup, sams new icons,
631 commit f87479bd556ea7db4afdd02297fc00977412b873
632 Author: Good Guy <good1.2guy@gmail.com>
633 Date: Sat Feb 17 18:09:22 2018 -0700
636 For the \texttt{git checkout <version>}, you would then keyin the
637 line below for the following results:
639 \begin{lstlisting}[style=nil]
640 git checkout f87479bd556ea7db4afdd02297fc00977412b873
642 Note: checking out 'f87479bd556ea7db4afdd02297fc00977412b873'.
644 You are in 'detached HEAD' state. You can look around, make
645 experimental changes and commit them, and you can discard any
646 commits you make in this state without impacting any branches by
647 performing another checkout.
649 If you want to create a new branch to retain commits you create,
650 you may do so (now or later) by using -b with the checkout command
653 git checkout -b <new-branch-name>
655 HEAD is now at f87479bd... more file size icon updates,
656 and more to followend
659 Later to get the repo back to current, use:
660 \begin{lstlisting}[style=sh]
665 \subsection{Debuggable Single User Build}%
666 \label{sub:debuggable_single_user_build}
667 \index{single-user build}
670 To build from source with full debugging symbols, first build a full
671 static (non\_debug) build as follows but instead of using
672 \texttt{/tmp} substitute your permanent disk path if you want to
675 \begin{lstlisting}[style=sh]
677 git clone --depth 1 "git://git.cinelerra-gg.org/goodguy/cinelerra.git" cinelerra5
678 cp -a /<repo_path>/cinelerra-5.1 /tmp/
679 cd /tmp/cinelerra-5.1
683 Then, to run as a developer in the debugger:
685 \begin{lstlisting}[style=sh]
686 CFLAGS="-O2 -ggdb" make -j8 rebuild_all
692 \subsection{Unbundled Builds}%
693 \label{sub:unbundled_builds}
698 There are some generic build scripts included in the \CGG{} GIT
699 repository for users who want to do unbundled builds with ffmpeg
700 already available on their system. This has been tested on Arch,
701 Ubuntu 18, FreeBSD, Windows10 and Leap 15 (rpm) at the time this
704 The names of the build scripts are: \texttt{arch.bld},
705 \texttt{bsd.bld}, \texttt{deb.bld}, \texttt{rpm.bld}, and
706 \texttt{cygwin.bld}. These scripts are in the \texttt{blds}
707 subdirectory. The \texttt{bsd.bld} should be used with the
708 \texttt{bsd.patch} file in that same directory. The
709 \texttt{cygwin.bld} should be used with the \texttt{cygwin.patch}
710 file in that same directory.
712 The reason that Cin Infinity traditionally uses its own thirdparty builds
713 (bundled builds) is because there are a lot of different distros
714 with varying levels of ffmpeg and other needed thirdparty
715 libraries. However, some users prefer using their current system
716 baseline without another/different copy of ffmpeg.
718 With different levels of the user’s libraries, uncertainty,
719 potential instability, and unknown issues may come up while
720 running \CGG{} and this will make it, for all practical purposes,
721 impossible to diagnose and debug problems or crashes.
723 There may be no help in these cases. You are encouraged to report
724 any errors which potentially originate from Cin Infinity, but if
725 the data indicates alternate library sources, please report the
726 problems to the appropriate maintainers.
728 With the unbundled builds, some features may not be available and
729 no attempt to comment them out has been made. So if you use a
730 pulldown, or pick a render option, or choose something that is not
731 available, it just will not work. For example, unless special
732 options were set up by you, the LV2 audio plugins will not be
733 available. Nor will the codec libzmpeg, the file codec ac3, or
734 DVD creation. The old school file classes will all work, but some
735 of the formats that come with ffmpeg may not because of the way
736 that ffmpeg was installed on your operating system. That is
737 because the \CGG{} included ffmpeg is a known static build and is
738 usually the latest stable/released version. For example, in the
739 current case of Leap 15, libx264 and libx265 are not built in and
740 this can be debilitating; you can always run \texttt{ffmpeg
741 -formats} and \texttt{ffmpeg -codecs} to see what is available
744 \section{Windows 10 with Cygwin for \CGG{} Limited}%
745 \label{sec:ms_windows10}
748 To run \CGG{} on a Windows 10 computer, you will need to have
749 Cygwin installed on your system, along with the \CGG{} static tar
750 and a patched library: libxcb. This setup has been tested with
751 Windows 10, version 1909, on an HP EliteBook 820 at 2.3 GHz.
753 This limited version provides \textit{core} functionality at this
754 time with the standard Windows FFmpeg executable, meaning that
755 specific modifications in FFmpeg needed for \CGG{} are not
756 available. Limited capabilities include only a few render output
757 formats available - for example \textit{mov}, \textit{qt} as
758 \textit{mjpeg}, and \textit{mpeg} for videos and \textit{avi} and
759 \textit{qt} as \textit{s16le} for audio, but not \textit{mkv} or
760 \textit{mp4}. This is due to the fact that several codec and
761 utility libraries are not currently compiled to work with Windows.
763 \subsection*{Installing Cygwin}
764 \label{sec:installing_cygwin}
767 Cygwin is an environment that runs natively on Windows which
768 allows Unix programs to be compiled and run on Windows. With
769 cygwin installed on your Windows 10 computer, you will be able to
770 run \CGG{}. Before installing cygwin, you need to be warned that
771 the Avast anti-virus software kills files necessary for cygwin
772 installation and execution, so you will have to remove it and use
773 alternative anti-virus software (the standard default already
774 included with Windows 10 is Defender). Below are the steps for
778 \item Download cygwin for your 64-bit computer at:
779 \href{https://www.cygwin.com/}{https://www.cygwin.com/}
781 \item Generally just take the defaults as they show up, but the
782 next steps show what comes up.
784 \item When a warning window pops up, click \textit{Yes}.
786 \item Click \textit{Next}.
788 \item Choose \textit{Install from Internet} option and then click
791 \item Choose your desired directory by clicking on Browse
792 button. Choose \textit{All Users (Recommended)} and then click
795 \item Choose the local package directory where you would like your
796 installation files to be placed. Click \textit{Next}.
798 \item Choose \textit{Direct Connection} if you are using Internet
799 with plug and play device. Click \textit{Next}.
801 \item Choose any download site preferably
802 ``cygwin.mirror.constant.com'' and then click \textit{Next}.
804 \item For list of things to install, leave all set to
805 \textit{Default} except these to \textit{Install} instead:
814 This install takes a long time; approximately 2 hours on an
815 EliteBook and requires approximately 20GB storage.
817 \item Finally you will want to have the icons on your desktop
818 (already default) and then click \textit{Finish}.
821 Then to install the \CGG{} tar files, you will need to start a
822 cygwin console terminal from the startup menu as shown here:
823 \texttt{Start $\rightarrow$ Cygwin $\rightarrow$ Cygwin64}
826 \subsection*{Installing \CGG{}}
827 \label{sec:installing_cinelerra}
830 \item Download the tar file
831 \href{https://cinelerra-gg.org/download/testing/libxcb-bld.tar.bz2}{libxcb-bld.tar.bz2}.
833 \item Install libxcb from the tar file -- installs into
834 \texttt{/usr/local} and requires approximately 21MB storage.
835 \begin{lstlisting}[style=sh]
836 tar -C /usr/local -xJf /path/libxcb-bld.tar.bz2
838 The libxcb patch repairs an error (XIOError), which stops
841 \item Download the tar file
842 \href{https://cinelerra-gg.org/download/testing/cygcin-bld.tar.bz2}{cygcin-bld.tar.bz2}.
844 \item Install cygcin from the tar file - this installs into home
845 directory. Note this is cygcin \emph{not} cygwin. You must change the
846 \texttt{path} below to the name of the path where you downloaded
848 \begin{lstlisting}[style=sh]
850 tar -xJf /path/cygcin-bld.tar.bz2
854 This creates \texttt{\~{}/cygcin}, a user build installation of
855 \CGG{} and requires approximately 400MB storage.
857 \paragraph{Running \CGG{}:}
858 You will need to start a cygwin desktop from the startup menu:
860 \item \texttt{Start$\rightarrow$ Cygwin-X $\rightarrow$ Openbox}
862 You should start a console controlling terminal so that you can
865 \item \texttt{Start$\rightarrow$ Cygwin $\rightarrow$ Cygwin64} Terminal
867 This opens a separate window that can survive a cygwin hang and
868 bugs. Without these logs, it is much more difficult to use.
870 \item Type into that console controlling window, the following:
871 \begin{lstlisting}[style=sh]
875 \item Change directories to where \CGG{} is installed:
876 \begin{lstlisting}[style=sh]
877 cd /path/cygcin (NOT cygwin)
881 \begin{lstlisting}[style=sh]
884 which starts up your 4 \CGG{} windows.
887 The most noticeable difference from the Linux versions is that
888 \CGG{} seems to run very slowly on Windows 10. You must be very
889 tolerant and patient to see this work. It can however exhibit
890 astonishing speed when encoding. \CGG{} has to be downgraded
891 significantly due to lack of supported interfaces, codecs (for
892 example h264/h265), and utilities. The only graphics driver is
893 X11 and the only sound driver is pulseaudio. Almost all
894 configurable omissions are applied to this build.
896 \paragraph{\CGG{} build on cygwin from source code:}
899 \item Download and install ffmpeg into /usr/local :
901 download ffmpeg (currently 4.2.2)
902 \begin{lstlisting}[style=sh]
904 tar -xJf /path/ffmpeg-4.2.2.tar.bz2
911 \item Download and install a patched libxcb:
912 \begin{lstlisting}[style=sh]
915 tar -xf /path/libxcb-1.13.tar.bz2
917 patch -p1 < /path/cinelerra-5.1/thirdparty/src/libxcb.patch1
918 patching file configure.ac
919 patching file src/xcb_in.c
925 \item Download cinelerra-gg:
926 \begin{lstlisting}[style=sh]
928 git clone "git://git.cinelerra-gg.org/goodguy/cinelerra.git"
929 cd cinelerra-gg/cinelerra-5.1
931 \item Apply cygwin patch:
932 \begin{lstlisting}[style=sh]
933 patch -p2 < blds/cygwin.patch
935 \item Run the build with:
936 \begin{lstlisting}[style=sh]
941 This produces a directory: /build\_path/cinelerra-gg/cinelerra-5.1/bin
942 which is used to create the cygcin archive.
944 Currently, the targets are not stripped and can be run from gdb.
945 There is only very limited signal handler dmp file support.
946 Running gdb from inside a desktop resident console (not a cygwin64
947 window) will hang cygwin (and cin) when it hits a breakpoint. You
948 must run from an external console window to avoid this issue.
951 \section{Distro with \CGG{} Included}%
952 \label{sec:distro_with_cinelerra_included}
955 There are also some special complete distribution systems
956 available that include \CGG{} for audio and video production
959 \subsection{AV Linux}
962 \textbf{AV Linux} is a downloadable/installable shared snapshot
963 ISO image based on MX Linux. It provides the user an easy method to
964 get an Audio and Video production workstation without the hassle
965 of trying to find and install all of the usual components
966 themselves. Of course, it includes \CGG{}!
969 \href{http://www.bandshed.net/avlinux/}{homepage of AV Linux}.
971 \subsection{Bodhi Linux Media}
972 \label{sec:Bodhi_Linux}
974 \textbf{Bodhi Linux Media} is a free and open source distribution that
975 comes with a curated list of open source software for digital
976 artists who work with audio, video, includes \CGG{}, games,
977 graphics, animations, physical computing, etc.
980 \href{https://gitlab.com/giuseppetorre/bodhilinuxmedia}{homepage of Bodhi Linux}.
982 \subsection{DeLinuxCo}
983 \label{sec:delinuxco}
985 \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{}.
987 You can read all about DeLinuxCo \href{https://www.delinuxco.com/}{here} and download \href{https://www.delinuxco.com/download/}{here}.
992 \textbf{Elive}, or Enlightenment live CD, is a non-commercial, cost-free operating system based on Debian, for the daily use and it can be used both as live CD or 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.
994 Click \href{https://www.elivecd.org/}{Elive} for more information.
996 \section{Cinx and a “Bit” of Confusion}%
997 \label{sec:cinx_and_a_bit_of_confusion}
1000 Cinx is the exact same program as Cin. The X (x) represents the
1001 roman numeral 10 for 10-bit as opposed to 8-bit standard. The
1002 third-party library used for x265 must be specially compiled with
1003 \texttt{--bit-depth=10} in order to produce 10-bit rendered
1004 output. A cinx version can be built for most other distros if
1005 rendering at 10-bit is desirable instead of 8-bit.
1007 This build will not be able to output 8-bit depth which means you
1008 have to retain the Cin version also.
1010 Whatever build ffmpeg is linked to will determine what bit depth
1011 it can output. This is why there have to be separate builds. If
1012 you install both packages, Cin and CinX, you may get \textit{file
1013 conflicts of same file name} --- just continue.
1015 Keep in mind that the regular 8-bit version works on 8-bit bytes
1016 --- the standard word size for computers, but the 10-bit version
1017 has to use 2 words to contain all 10 bits so you can expect
1018 rendering to be as much as twice as slow.
1020 There is also a 12-bit version for consideration but currently the
1021 results are simply the same as 10-bit with padding to make 12-bit
1022 so it is of no value.
1025 %%% Local Variables:
1027 %%% TeX-master: "../CinelerraGG_Manual"