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 Alternatively, there are some pre-built dynamic or static binaries
133 which are updated on a fairly regular basis (as long as code changes
134 have been made) available at the link below.
136 \href{https://cinelerra-gg.org/download/}{https://cinelerra-gg.org/download/}
139 There are 2 kinds of builds, the default system-build and a
140 single-user build. A system build has results which are installed
141 to the system. The majority of the files are installed in the
142 standard system paths, but some customization is possible. The
143 single user build allows for running completely out of a local
144 user directory so it doesn't affect the system.
146 We recommend the single-user version when possible. It makes it
147 very easy to install a new version without having to delete the
148 older version in case you want it for backup -- once you are happy
149 with the new version, all you have to do is delete the entire old
150 directory path. Another reason for using single-user is that if
151 you install a new Operating System version and if you have \CGG{}
152 on separate disk space that is preserved, you won't have to
153 reinstall \CGG{}. It is also convenient for the purpose of having
154 the ability to interrupt or to see any possible error messages, if
155 you start the application from a terminal window command line
156 where you will have more control to catch problems. All that
157 said, the system builds can be useful in a university lab setting
158 where there are possibly multiple users, or multiple versions.
160 There are two notable differences between standard views
161 of \CGG{} and this implementation for the system builds. Both of
162 these can be configured during installation. The differences make
163 it possible to have several different versions installed without
164 having them interfere with each other.
167 \item application name can be set during a build but defaults
169 \item the home configuration directory can also be set and
170 traditionally defaults to: \texttt{\$HOME/.bcast5}
174 \subsection{The system build}
175 \label{sec:system-build}
178 To do a system build \index{build} , you should read the file
179 \texttt{README} that is at the top level after you get the source.
182 \item You need about 6.0 \,GB of disk storage to operate a build and
183 you need to have \textit{git} installed.
185 \item Obviously in order to install into the system, you must run as
188 \item The \textit{git:} step has to download many files (approx
189 130\,MB) so allow time. When decompressed this will expand to
192 \item Run the following commands (this takes awhile):
194 \begin{lstlisting}[style=sh]
195 # This is where you need the 6.0GB of disk space:
197 git clone --depth 1 "git://git.cinelerra-gg.org/goodguy/cinelerra.git" cinelerra5
198 # Change to the cloned directory:
199 cd cinelerra5/cinelerra-5.1
201 NOTE: if your system has never had \CGG{} Infinity installed, you
202 will have to make sure you have all of the compilers and libraries
203 necessary. So on the very first build you should run:
205 \begin{lstlisting}[style=sh]
206 ./blds/bld_prepare.sh <os> # where <os> represents the
207 # Operating System of
208 # centos, fedora, suse, ubuntu, mint, debian.
210 ./configure --prefix=/usr # optional parameters can be added here
211 make 2>&1 | tee log # make and log the build
214 \texttt{bld\_prepare.sh} does not work for Arch Linux or Gentoo,
215 so we have to install the dependencies
216 manually. \texttt{README.arch} or \texttt{README.gentoo}, which
217 contain the list of dependencies, can be found at:
219 \item \href{https://cinelerra-gg.org/download/README.arch}{https://cinelerra-gg.org/download/README.arch}
220 \item \href{https://cinelerra-gg.org/download/README.gentoo}{https://cinelerra-gg.org/download/README.gentoo}
223 \item Check for obvious build errors:
224 \begin{lstlisting}[style=sh]
225 grep "\*\*\*.*error" -ai log
227 If this reports errors and you need assistance or you think
228 improvements can be made to the builds, email the log which is
230 \href{mailto:cin@lists.cinelerra-gg.org}{cin@lists.cinelerra-gg.org}
231 \begin{lstlisting}[style=sh]
232 /<build_path>/cinelerra5/cinelerra-5.1/log
235 \item If there are no build errors, finally just run:
236 \begin{lstlisting}[style=sh]
239 Where <os> represents the Operating System supported by \CGG{}, such
240 as centos, fedora, suse, ubuntu, mint, debian.
241 The ``with-single-user'' parameter makes it so.
242 % Make and log build (
243 Check for errors before proceeding.
246 \item If it all worked, you are all setup. Just click on the \CGG{}
251 \subsection{The single-user build}
252 \label{sec:single-user-build}
253 \index{single-user build}
256 To do a single-user build, read the file \texttt{README} that is at
257 the top level after you get the source.
260 \item You need at least 6\,GB of disk storage to operate a build +
261 you need to have “\texttt{git}” installed.
263 \item Recommend you build and run as \textbf{root}, just to avoid
264 permission issues initially.
265 \item The \textit{git} step has to download many files (approx
266 130\,MB) so allow time.
268 \item Run the following commands (this takes awhile):
269 \begin{lstlisting}[style=sh]
270 # This is where you need the 6GB of disk space
272 git clone --depth 1 "git://git.cinelerra-gg.org/goodguy/cinelerra.git" cinelerra5
273 # Toplevel directory:
274 cd cinelerra5/cinelerra-5.1
278 NOTE: if your system has never had \CGG{} Infinity installed, you
279 will have to make sure all the compilers and libraries necessary are
280 installed. So on the very first build you should run as
283 % FIXME No novels in the listings.
284 \begin{lstlisting}[style=sh]
285 ./blds/bld_prepare.sh <os>
287 ./configure --with-single-user
291 Where <os> represents the Operating System supported by \CGG{}, such
292 as centos, fedora, suse, ubuntu, mint, debian.
293 The ``with-single-user'' parameter makes it so.
294 % Make and log build (
295 Check for errors before proceeding.
298 Then just start the application by keying in: \texttt{./cin} in the
299 bin subdirectory OR add a desktop icon by using the appropriate
300 directory to copy the files to, run as \textbf{root}, and edit to
301 correct the directory path. Below are generic directions of how to
304 Then just start the application by keying in: \texttt{./cin} in the
305 bin subdirectory OR add a desktop icon by using the appropriate
306 directory to copy the files to, run as \textbf{root}, and edit to
307 correct the directory path. Below are generic directions of how to
310 \begin{lstlisting}[style=sh]
311 cd /cinelerra_directory_path
312 cp -a image/cin.{svg,xpm} /usr/share/pixmaps/
313 cp -a image/cin.desktop /usr/share/applications/cin.desktop
316 After you have followed the above, in the cin.desktop file, change
317 the \texttt{Exec=cin} line to be
318 \texttt{Exec=<your\_directory\_path>/bin/cin}.
320 The preceding directions for doing a single-user build may work
321 without being root on some distros except for the \texttt{bld\_prepare.sh}
322 and creating the desktop icon. For example in Arch Linux installing without being root
323 works using the following steps:
325 \begin{lstlisting}[style=sh]
326 $ git clone --depth 1 "git://git.cinelerra-gg.org/goodguy/cinelerra.git" cinelerra5
327 $ cd /home/USER/cinelerra5/cinelerra-5.1
329 $ ./configure --prefix=/usr --with-single-user --with-booby
330 $ make 2>&1 | tee /tmp/cin5.log && make install
334 \subsection{Notable Options and Caveats}%
335 \label{sub:notable_options_and_caveats}
338 These procedures and the \CGG{} Infinity software have all been run
339 as \textbf{root} on various home laptops and desktops. This provides
340 the best chance to ensure all works correctly and also allows for
341 handling errors, other problems and potential crashes with the most
342 success. Included in this section are some of the build variations
343 easily available for normal builds.
345 To see the full list of features use:
347 \begin{lstlisting}[style=sh]
350 The default build \index{build} is a system build which uses:
352 \begin{lstlisting}[style=sh]
353 ./configure --without-single-user
356 In the single-user build \index{single-user build}, the target directory is always
357 \texttt{cin}. Because this is also the developer build, constant
358 names are used throughout. However, you can rename files after the
361 If your operating system has issues with the default install to
362 \texttt{/usr/local}, you might have to change the location to
363 \texttt{/usr} for a system build. Then you will have to use:
364 \begin{lstlisting}[style=sh]
365 ./configure --prefix=/usr
368 If you wish to change the default directory for a system build you
369 will have to add the destination directory path on the \texttt{make
370 install} line. For example:
371 \begin{lstlisting}[style=sh]
372 make install DESTDIR=<your selected target directory path>
375 The application name can be set during installation, but defaults to
376 \texttt{cin} so that the GG/Infinity build can coexist with other
377 \CGG{} builds if necessary. To override the default \texttt{cin}
379 \begin{lstlisting}[style=sh]
380 ./configure --with-exec-name=cinelerra
383 The home configuration directory can also be set, but default
384 location is traditionally \texttt{\$HOME/.bcast5}. For example:
386 \begin{lstlisting}[style=sh]
387 ./configure -with-config-dir=/myusername/.bcast5
390 NOTE: when you specify parameters to the configure program, it will
391 create a \texttt{make} file as a consequence. Since in a
392 \texttt{make} file, the \$ is a special character, it must be
393 escaped so in order to represent a \$ as part of an input parameter,
394 it has to be stuttered. That is, you will need \$\$ (2 dollar
395 signs) to represent a single dollar sign.
397 It may be necessary on some distros which have missing or incomplete
398 up-to-date libraries, to build \CGG{} without Ladspa. To do so,
401 \begin{lstlisting}[style=sh]
402 ./configure --prefix=/usr --without-ladspa-build
405 Note that the with-ladspa-dir is the ladspa search path, and
406 exists even if the ladspa build is not selected. This gives you
407 the ability to specify an alternate ladspa system path by
408 utilizing the \texttt{LADSPA\_PATH} environment variable (that is,
409 the default ladspa build is deselected).
411 Note for 32-bit 14.2 Slackware, Debian, Gentoo, Arch, FreeBSD,
412 before running the configure, you will need to set up the following:
414 \begin{lstlisting}[style=sh]
415 export ac_cv_header_xmmintrin_h=no
416 export FFMPEG_EXTRA_CFG=" --disable-vdpau"
420 \subsection{Notes about Building from Git in your Customized Environment}%
421 \label{sub:notes_about_building_from_git_in_your_customized_environment}
426 Getting a build to work in a custom environment is not easy. If you
427 have already installed libraries which are normally in the
428 thirdparty build, getting them to be recognized means you have to
429 install the \textit{devel} version so the header files which match
430 the library interfaces exist. Below is the list of thirdparty
431 builds, but this list may have changed over time.
432 % It's list of Table?
436 \caption{List of thirdparty builds}
437 \label{tab:List_of_thirdparty_builds}
439 \begin{tabular}{m{8em}c}
483 The \textit{yes} means force build and \textit{auto} means probe and
484 use the system version if the build operation is not static. To get
485 your customized build to work, you need to change the probe options
486 for the conflicting libraries from \textit{yes} to \textit{auto}, or
487 even rework the \texttt{configure.ac} script. There may be several
488 libraries which need special treatment.
490 An example of a problem you might encounter with your customized
491 installation is with \texttt{a52dec} which has probes line
492 \texttt{(CHECK\_LIB/CHECK\_HEADERS)} in \texttt{configure.ac}, but
493 \texttt{djbfft} does not. In this case, \texttt{djbfft} is only
494 built because \texttt{a52dec} is built, so if your system has
495 \texttt{a52dec}, set \texttt{a52dec} to auto and see if that
496 problem is solved by retrying the build with:
497 \begin{lstlisting}[style=sh]
498 ./confgure --with-single-user -enable-a52dec=auto .
501 With persistence, you can get results, but it may take several tries
502 to stabilize the build. If you need help, email the \texttt{log}
503 and \texttt{config.log}, which is usually sufficient to determine
506 If you have already installed the \texttt{libfdk\_aac} development
507 package on your computer because you prefer this version over the
508 default aac, you will have to do the following to get this
509 alternative operational. The libfdk\_aac library is not a part of
510 \CGG{} by default because it is not license free.
512 \begin{lstlisting}[style=sh]
513 export FFMPEG_EXTRA_CFG=" --enable-libfdk-aac --enable-nonfree"
514 export EXTRA_LIBS=" -lfdk-aac"
515 for f in `grep -lw aac cinelerra-5.1/ffmpeg/audio/*`; do
516 sed -e 's/\<aac\>/libfdk_aac/' -i $f
521 \subsection{Cloning the Repository for Faster Updates}%
522 \label{sub:cloning_the_repository_for_faster_updates}
526 If you want to avoid downloading the software every time an update
527 is available you need to create a local ``repository'' or repo. The
528 repo is a directory where you first do a \texttt{git clone}. For
529 the initial git clone, set up a local area for the repository
530 storage, referred to as \texttt{<repo\_path>}. The \texttt{git
531 clone} creates a repo named \texttt{cin5} in the
532 \texttt{/<repo\_path>/} directory. This accesses about 530\,MB of
533 repo data, so the device has to have at least that available. The
534 repo path is always a perfect clone of the main repo.
537 \paragraph{Setting up the initial clone}%
538 \label{par:setting_up_the_initial_clone}
540 You may want to add ``\verb|--depth 1|'' before \texttt{cin5}
541 because this will clone faster and is smaller, but has no history.
543 \begin{lstlisting}[style=sh]
545 git clone "git://git.cinelerra-gg.org/goodguy/cinelerra" cin5
547 Cloning into "cin5"...
548 remote: Counting objects: 20032, done.
549 remote: Compressing objects: 100% (11647/11647), done.
550 remote: Total 20032 (delta 11333), reused 16632 (delta 8189)
551 Receiving objects: 100% (20032/20032), 395.29 MiB | 3.26 MiB/s, done.
552 Resolving deltas: 100% (11333/11333), done.
553 Checking connectivity... done.
557 \paragraph{Update an existing repo}%
558 \label{par:update_an_existing_repo}
559 The below shows how you can get updates.
561 \begin{lstlisting}[style=sh]
567 \paragraph{Useful git commands}%
568 \label{par:useful_git_commands}
569 Some other commands that are useful.
571 \begin{lstlisting}[style=sh]
572 git clone "git://git.cinelerra-gg.org/goodguy/cinelerra.git" cin5
573 git pull # pull remote changes to the local version
574 git status # shows changed files
575 git clean -i # interactive clean, use answer 1 to "clean"
579 \subsection{How to Build from a Previous GIT Version}%
580 \label{sub:how_to_build_from_a_previous_git_version}
585 If you have a problem with the current GIT version, you can revert
586 to a previous working version easily. The commands to use will be
587 similar to these next lines which are then explained in more detail.
590 \begin{lstlisting}[style=sh]
591 cd /<path>/cin5 # substitute your repo path name for cin5
592 git log # shows a list of versions depending on history depth specification
593 git checkout <version> # choose a version number as listed
596 The \texttt{git log} command produces a log file with hash values
597 for commit keys to the level specifed if the the depth paramter
599 The hash ids are the commit names to use when you
600 use git checkout. Next is displayed sample output:
602 \begin{lstlisting}[style=nil]
603 delete stray line in last checkin
605 commit 4a90ef3ae46465c0634f81916b79e279e4bd9961
606 Author: Good Guy <good1.2guy@gmail.com>
607 Date: Thu Feb 22 14:56:45 2018 -0700
609 nested clips, big rework and cleanup, sams new icons,
612 commit f87479bd556ea7db4afdd02297fc00977412b873
613 Author: Good Guy <good1.2guy@gmail.com>
614 Date: Sat Feb 17 18:09:22 2018 -0700
617 For the \texttt{git checkout <version>}, you would then keyin the
618 line below for the following results:
620 \begin{lstlisting}[style=nil]
621 git checkout f87479bd556ea7db4afdd02297fc00977412b873
623 Note: checking out 'f87479bd556ea7db4afdd02297fc00977412b873'.
625 You are in 'detached HEAD' state. You can look around, make
626 experimental changes and commit them, and you can discard any
627 commits you make in this state without impacting any branches by
628 performing another checkout.
630 If you want to create a new branch to retain commits you create,
631 you may do so (now or later) by using -b with the checkout command
634 git checkout -b <new-branch-name>
636 HEAD is now at f87479bd... more file size icon updates,
637 and more to followend
640 Later to get the repo back to current, use:
641 \begin{lstlisting}[style=sh]
646 \subsection{Debuggable Single User Build}%
647 \label{sub:debuggable_single_user_build}
648 \index{single-user build}
651 To build from source with full debugging symbols, first build a full
652 static (non\_debug) build as follows but instead of using
653 \texttt{/tmp} substitute your permanent disk path if you want to
656 \begin{lstlisting}[style=sh]
658 git clone --depth 1 "git://git.cinelerra-gg.org/goodguy/cinelerra.git" cinelerra5
659 cp -a /<repo_path>/cinelerra-5.1 /tmp/
660 cd /tmp/cinelerra-5.1
664 Then, to run as a developer in the debugger:
666 \begin{lstlisting}[style=sh]
667 CFLAGS="-O2 -ggdb" make -j8 rebuild_all
673 \subsection{Unbundled Builds}%
674 \label{sub:unbundled_builds}
679 There are some generic build scripts included in the \CGG{} GIT
680 repository for users who want to do unbundled builds with ffmpeg
681 already available on their system. This has been tested on Arch,
682 Ubuntu 18, FreeBSD, Windows10 and Leap 15 (rpm) at the time this
685 The names of the build scripts are: \texttt{arch.bld},
686 \texttt{bsd.bld}, \texttt{deb.bld}, \texttt{rpm.bld}, and
687 \texttt{cygwin.bld}. These scripts are in the \texttt{blds}
688 subdirectory. The \texttt{bsd.bld} should be used with the
689 \texttt{bsd.patch} file in that same directory. The
690 \texttt{cygwin.bld} should be used with the \texttt{cygwin.patch}
691 file in that same directory.
693 The reason that Cin Infinity traditionally uses its own thirdparty builds
694 (bundled builds) is because there are a lot of different distros
695 with varying levels of ffmpeg and other needed thirdparty
696 libraries. However, some users prefer using their current system
697 baseline without another/different copy of ffmpeg.
699 With different levels of the user’s libraries, uncertainty,
700 potential instability, and unknown issues may come up while
701 running \CGG{} and this will make it, for all practical purposes,
702 impossible to diagnose and debug problems or crashes.
704 There may be no help in these cases. You are encouraged to report
705 any errors which potentially originate from Cin Infinity, but if
706 the data indicates alternate library sources, please report the
707 problems to the appropriate maintainers.
709 With the unbundled builds, some features may not be available and
710 no attempt to comment them out has been made. So if you use a
711 pulldown, or pick a render option, or choose something that is not
712 available, it just will not work. For example, unless special
713 options were set up by you, the LV2 audio plugins will not be
714 available. Nor will the codec libzmpeg, the file codec ac3, or
715 DVD creation. The old school file classes will all work, but some
716 of the formats that come with ffmpeg may not because of the way
717 that ffmpeg was installed on your operating system. That is
718 because the \CGG{} included ffmpeg is a known static build and is
719 usually the latest stable/released version. For example, in the
720 current case of Leap 15, libx264 and libx265 are not built in and
721 this can be debilitating; you can always run \texttt{ffmpeg
722 -formats} and \texttt{ffmpeg -codecs} to see what is available
725 \section{Windows 10 with Cygwin for \CGG{} Limited}%
726 \label{sec:ms_windows10}
729 To run \CGG{} on a Windows 10 computer, you will need to have
730 Cygwin installed on your system, along with the \CGG{} static tar
731 and a patched library: libxcb. This setup has been tested with
732 Windows 10, version 1909, on an HP EliteBook 820 at 2.3 GHz.
734 This limited version provides \textit{core} functionality at this
735 time with the standard Windows FFmpeg executable, meaning that
736 specific modifications in FFmpeg needed for \CGG{} are not
737 available. Limited capabilities include only a few render output
738 formats available - for example \textit{mov}, \textit{qt} as
739 \textit{mjpeg}, and \textit{mpeg} for videos and \textit{avi} and
740 \textit{qt} as \textit{s16le} for audio, but not \textit{mkv} or
741 \textit{mp4}. This is due to the fact that several codec and
742 utility libraries are not currently compiled to work with Windows.
744 \subsection*{Installing Cygwin}
745 \label{sec:installing_cygwin}
748 Cygwin is an environment that runs natively on Windows which
749 allows Unix programs to be compiled and run on Windows. With
750 cygwin installed on your Windows 10 computer, you will be able to
751 run \CGG{}. Before installing cygwin, you need to be warned that
752 the Avast anti-virus software kills files necessary for cygwin
753 installation and execution, so you will have to remove it and use
754 alternative anti-virus software (the standard default already
755 included with Windows 10 is Defender). Below are the steps for
759 \item Download cygwin for your 64-bit computer at:
760 \href{https://www.cygwin.com/}{https://www.cygwin.com/}
762 \item Generally just take the defaults as they show up, but the
763 next steps show what comes up.
765 \item When a warning window pops up, click \textit{Yes}.
767 \item Click \textit{Next}.
769 \item Choose \textit{Install from Internet} option and then click
772 \item Choose your desired directory by clicking on Browse
773 button. Choose \textit{All Users (Recommended)} and then click
776 \item Choose the local package directory where you would like your
777 installation files to be placed. Click \textit{Next}.
779 \item Choose \textit{Direct Connection} if you are using Internet
780 with plug and play device. Click \textit{Next}.
782 \item Choose any download site preferably
783 ``cygwin.mirror.constant.com'' and then click \textit{Next}.
785 \item For list of things to install, leave all set to
786 \textit{Default} except these to \textit{Install} instead:
795 This install takes a long time; approximately 2 hours on an
796 EliteBook and requires approximately 20GB storage.
798 \item Finally you will want to have the icons on your desktop
799 (already default) and then click \textit{Finish}.
802 Then to install the \CGG{} tar files, you will need to start a
803 cygwin console terminal from the startup menu as shown here:
804 \texttt{Start $\rightarrow$ Cygwin $\rightarrow$ Cygwin64}
807 \subsection*{Installing \CGG{}}
808 \label{sec:installing_cinelerra}
811 \item Download the tar file
812 \href{https://cinelerra-gg.org/download/testing/libxcb-bld.tar.bz2}{libxcb-bld.tar.bz2}.
814 \item Install libxcb from the tar file -- installs into
815 \texttt{/usr/local} and requires approximately 21MB storage.
816 \begin{lstlisting}[style=sh]
817 tar -C /usr/local -xJf /path/libxcb-bld.tar.bz2
819 The libxcb patch repairs an error (XIOError), which stops
822 \item Download the tar file
823 \href{https://cinelerra-gg.org/download/testing/cygcin-bld.tar.bz2}{cygcin-bld.tar.bz2}.
825 \item Install cygcin from the tar file - this installs into home
826 directory. Note this is cygcin \emph{not} cygwin. You must change the
827 \texttt{path} below to the name of the path where you downloaded
829 \begin{lstlisting}[style=sh]
831 tar -xJf /path/cygcin-bld.tar.bz2
835 This creates \texttt{\~{}/cygcin}, a user build installation of
836 \CGG{} and requires approximately 400MB storage.
838 \paragraph{Running \CGG{}:}
839 You will need to start a cygwin desktop from the startup menu:
841 \item \texttt{Start$\rightarrow$ Cygwin-X $\rightarrow$ Openbox}
843 You should start a console controlling terminal so that you can
846 \item \texttt{Start$\rightarrow$ Cygwin $\rightarrow$ Cygwin64} Terminal
848 This opens a separate window that can survive a cygwin hang and
849 bugs. Without these logs, it is much more difficult to use.
851 \item Type into that console controlling window, the following:
852 \begin{lstlisting}[style=sh]
856 \item Change directories to where \CGG{} is installed:
857 \begin{lstlisting}[style=sh]
858 cd /path/cygcin (NOT cygwin)
862 \begin{lstlisting}[style=sh]
865 which starts up your 4 \CGG{} windows.
868 The most noticeable difference from the Linux versions is that
869 \CGG{} seems to run very slowly on Windows 10. You must be very
870 tolerant and patient to see this work. It can however exhibit
871 astonishing speed when encoding. \CGG{} has to be downgraded
872 significantly due to lack of supported interfaces, codecs (for
873 example h264/h265), and utilities. The only graphics driver is
874 X11 and the only sound driver is pulseaudio. Almost all
875 configurable omissions are applied to this build.
877 \paragraph{\CGG{} build on cygwin from source code:}
880 \item Download and install ffmpeg into /usr/local :
882 download ffmpeg (currently 4.2.2)
883 \begin{lstlisting}[style=sh]
885 tar -xJf /path/ffmpeg-4.2.2.tar.bz2
892 \item Download and install a patched libxcb:
893 \begin{lstlisting}[style=sh]
896 tar -xf /path/libxcb-1.13.tar.bz2
898 patch -p1 < /path/cinelerra-5.1/thirdparty/src/libxcb.patch1
899 patching file configure.ac
900 patching file src/xcb_in.c
906 \item Download cinelerra-gg:
907 \begin{lstlisting}[style=sh]
909 git clone "git://git.cinelerra-gg.org/goodguy/cinelerra.git"
910 cd cinelerra-gg/cinelerra-5.1
912 \item Apply cygwin patch:
913 \begin{lstlisting}[style=sh]
914 patch -p2 < blds/cygwin.patch
916 \item Run the build with:
917 \begin{lstlisting}[style=sh]
922 This produces a directory: /build\_path/cinelerra-gg/cinelerra-5.1/bin
923 which is used to create the cygcin archive.
925 Currently, the targets are not stripped and can be run from gdb.
926 There is only very limited signal handler dmp file support.
927 Running gdb from inside a desktop resident console (not a cygwin64
928 window) will hang cygwin (and cin) when it hits a breakpoint. You
929 must run from an external console window to avoid this issue.
932 \section{Distro with \CGG{} Included}%
933 \label{sec:distro_with_cinelerra_included}
936 There are also some special complete distribution systems
937 available that include \CGG{} for audio and video production
940 \subsection{AV Linux}
943 \textbf{AV Linux} is a downloadable/installable shared snapshot
944 ISO image based on MX Linux. It provides the user an easy method to
945 get an Audio and Video production workstation without the hassle
946 of trying to find and install all of the usual components
947 themselves. Of course, it includes \CGG{}!
950 \href{http://www.bandshed.net/avlinux/}{homepage of AV Linux}.
952 \subsection{Bodhi Linux Media}
953 \label{sec:Bodhi_Linux}
955 \textbf{Bodhi Linux Media} is a free and open source distribution that
956 comes with a curated list of open source software for digital
957 artists who work with audio, video, includes \CGG{}, games,
958 graphics, animations, physical computing, etc.
961 \href{https://gitlab.com/giuseppetorre/bodhilinuxmedia}{homepage of Bodhi Linux}.
963 \subsection{DeLinuxCo}
964 \label{sec:delinuxco}
966 \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{}.
968 You can read all about DeLinuxCo \href{https://www.delinuxco.com/}{here} and download \href{https://www.delinuxco.com/download/}{here}.
973 \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.
975 Click \href{https://www.elivecd.org/}{Elive} for more information.
977 \section{Cinx and a “Bit” of Confusion}%
978 \label{sec:cinx_and_a_bit_of_confusion}
981 Cinx is the exact same program as Cin. The X (x) represents the
982 roman numeral 10 for 10-bit as opposed to 8-bit standard. The
983 third-party library used for x265 must be specially compiled with
984 \texttt{--bit-depth=10} in order to produce 10-bit rendered
985 output. A cinx version can be built for most other distros if
986 rendering at 10-bit is desirable instead of 8-bit.
988 This build will not be able to output 8-bit depth which means you
989 have to retain the Cin version also.
991 Whatever build ffmpeg is linked to will determine what bit depth
992 it can output. This is why there have to be separate builds. If
993 you install both packages, Cin and CinX, you may get \textit{file
994 conflicts of same file name} --- just continue.
996 Keep in mind that the regular 8-bit version works on 8-bit bytes
997 --- the standard word size for computers, but the 10-bit version
998 has to use 2 words to contain all 10 bits so you can expect
999 rendering to be as much as twice as slow.
1001 There is also a 12-bit version for consideration but currently the
1002 results are simply the same as 10-bit with padding to make 12-bit
1003 so it is of no value.
1006 %%% Local Variables:
1008 %%% TeX-master: "../CinelerraGG_Manual"