2 \label{cha:Installation}
5 \section{Download Already Built \CGG{}}%
6 \label{sec:download_already_built_cinelerra_gg}
10 \includegraphics[width=1.0\linewidth]{download-distros.png}
11 \caption{Screencast of the website Download page for installing \CGG{} for various O/S.}
12 \label{fig:download-distros}
15 If you prefer to not have to take the time to build \CGG{} Infinity
16 yourself, there are pre-built dynamic or static binaries for various
17 versions of Ubuntu, Mint, Suse, Fedora, Debian, Centos, Arch, and
18 Slackware linux as well as Gentoo and FreeBSD. If you do want to build it yourself so that
19 you get the added benefit of the latest checked in changes, please reference
20 ~\ref{sec:How_to_build}.
22 A Windows 10 version installation is described in~\ref{sec:ms_windows10}. There are also 32-bit i686 Ubuntu, Debian,
23 and Slackware versions available. These are updated on a fairly
24 regular basis as long as significant code changes have been made.
25 They are in subdirectories of:
28 \item \href{https://cinelerra-gg.org/download/tars}{https://cinelerra-gg.org/download/tars}
29 \item \href{https://cinelerra-gg.org/download/pkgs}{https://cinelerra-gg.org/download/pkgs}
32 The \textbf{tars} \index{tars} directory contains single-user static builds for
35 This is the recommended usage of \CGG{} because all of the files
36 will exist in a single directory. Generally all of the necessary
37 libraries are built into the static build, but in some cases you may
38 have to install another library that is being called for.
40 To install the single user builds, download the designated tarball
41 from the \texttt{./tars} subdirectory and unpack as indicated below:
43 \begin{lstlisting}[style=sh]
47 tar -xJf /src/path/cinelerra-5.1-*.txz # for the *, substitute your distro tarball name
50 \emph{Do not download the LEAP 10-bit version unless you specifically want to
51 use h265 rendering to 10-bit instead of the more standard 8-bit.} For more
52 information see ~\ref{sec:cinx_and_a_bit_of_confusion}.
54 The \textbf{pkgs} \index{pkgs} directory contains the standard packaged
55 application for various distros. This will install a dynamic
56 system version for users who prefer to have the binaries in the
57 system area and for multi-user systems.
59 In addition, performing the package install checks the md5sum in
60 the file \texttt{md5sum.txt} to ensure the channel correctly
61 transmits the package. There is a
62 \href{https://cinelerra-gg.org/download/README.pkgs}{README.pkgs}
63 file in the \texttt{download} directory with instructions so you
64 can \textit{cut and paste} and avoid typos; it is also shown
67 \lstset{inputpath=extra/}
70 basicstyle=\footnotesize,
74 \section{How to Build \CGG{} from Developer's Git Repository}%
75 \label{sec:How_to_build}
79 These are generic build instructions for building \CGG{} Infinity.
80 Known to work on Ubuntu, Mint, OpenSuse, Fedora, Debian, Centos,
81 Arch, Slackware, and Gentoo. It has not been tested on every
82 single possible distro yet so you might expect to have to make
83 some minor changes. Also works on a somewhat limited basis on
84 FreeBSD and Windows 10 with the bsd.patch for FreeBSD and the
85 cygwin.patch for Windows 10.
87 Alternatively, there are some pre-built dynamic or static binaries
88 which are updated on a fairly regular basis (as long as code changes
89 have been made) available at the link below.
91 \href{https://cinelerra-gg.org/download/}{https://cinelerra-gg.org/download/}
94 There are 2 kinds of builds, the default system-build and a
95 single-user build. A system build has results which are installed
96 to the system. The majority of the files are installed in the
97 standard system paths, but some customization is possible. The
98 single user build allows for running completely out of a local
99 user directory so it doesn't affect the system.
101 We recommend the single-user version when possible. It makes it
102 very easy to install a new version without having to delete the
103 older version in case you want it for backup -- once you are happy
104 with the new version, all you have to do is delete the entire old
105 directory path. Another reason for using single-user is that if
106 you install a new Operating System version and if you have \CGG{}
107 on separate disk space that is preserved, you won't have to
108 reinstall \CGG{}. It is also convenient for the purpose of having
109 the ability to interrupt or to see any possible error messages, if
110 you start the application from a terminal window command line
111 where you will have more control to catch problems. All that
112 said, the system builds can be useful in a university lab setting
113 where there are possibly multiple users, or multiple versions.
115 There are two notable differences between standard views
116 of \CGG{} and this implementation for the system builds. Both of
117 these can be configured during installation. The differences make
118 it possible to have several different versions installed without
119 having them interfere with each other.
122 \item application name can be set during a build but defaults
124 \item the home configuration directory can also be set and
125 traditionally defaults to: \texttt{\$HOME/.bcast5}
129 \subsection{The system build}
130 \label{sec:system-build}
133 To do a system build \index{build} , you should read the file
134 \texttt{README} that is at the top level after you get the source.
137 \item You need about 6.0 \,GB of disk storage to operate a build and
138 you need to have \textit{git} installed.
140 \item Obviously in order to install into the system, you must run as
143 \item The \textit{git:} step has to download many files (approx
144 130\,MB) so allow time. When decompressed this will expand to
147 \item Run the following commands (this takes awhile):
149 \begin{lstlisting}[style=sh]
150 # This is where you need the 6.0GB of disk space:
152 git clone --depth 1 "git://git.cinelerra-gg.org/goodguy/cinelerra.git" cinelerra5
153 # Change to the cloned directory:
154 cd cinelerra5/cinelerra-5.1
156 NOTE: if your system has never had \CGG{} Infinity installed, you
157 will have to make sure you have all of the compilers and libraries
158 necessary. So on the very first build you should run:
160 \begin{lstlisting}[style=sh]
161 ./blds/bld_prepare.sh <os> # where <os> represents the
162 # Operating System of
163 # centos, fedora, suse, ubuntu, mint, debian.
165 ./configure --prefix=/usr # optional parameters can be added here
166 make 2>&1 | tee log # make and log the build
169 \texttt{bld\_prepare.sh} does not work for Arch Linux or Gentoo,
170 so we have to install the dependencies
171 manually. \texttt{README.arch} or \texttt{README.gentoo}, which
172 contain the list of dependencies, can be found at:
174 \item \href{https://cinelerra-gg.org/download/README.arch}{https://cinelerra-gg.org/download/README.arch}
175 \item \href{https://cinelerra-gg.org/download/README.gentoo}{https://cinelerra-gg.org/download/README.gentoo}
178 \item Check for obvious build errors:
179 \begin{lstlisting}[style=sh]
180 grep "\*\*\*.*error" -ai log
182 If this reports errors and you need assistance or you think
183 improvements can be made to the builds, email the log which is
185 \href{mailto:cin@lists.cinelerra-gg.org}{cin@lists.cinelerra-gg.org}
186 \begin{lstlisting}[style=sh]
187 /<build_path>/cinelerra5/cinelerra-5.1/log
190 \item If there are no build errors, finally just run:
191 \begin{lstlisting}[style=sh]
194 Where <os> represents the Operating System supported by \CGG{}, such
195 as centos, fedora, suse, ubuntu, mint, debian.
196 The ``with-single-user'' parameter makes it so.
197 % Make and log build (
198 Check for errors before proceeding.
201 \item If it all worked, you are all setup. Just click on the \CGG{}
206 \subsection{The single-user build}
207 \label{sec:single-user-build}
208 \index{single-user build}
211 To do a single-user build, read the file \texttt{README} that is at
212 the top level after you get the source.
215 \item You need at least 6\,GB of disk storage to operate a build +
216 you need to have “\texttt{git}” installed.
218 \item Recommend you build and run as \textbf{root}, just to avoid
219 permission issues initially.
220 \item The \textit{git} step has to download many files (approx
221 130\,MB) so allow time.
223 \item Run the following commands (this takes awhile):
224 \begin{lstlisting}[style=sh]
225 # This is where you need the 6GB of disk space
227 git clone --depth 1 "git://git.cinelerra-gg.org/goodguy/cinelerra.git" cinelerra5
228 # Toplevel directory:
229 cd cinelerra5/cinelerra-5.1
233 NOTE: if your system has never had \CGG{} Infinity installed, you
234 will have to make sure all the compilers and libraries necessary are
235 installed. So on the very first build you should run as
238 % FIXME No novels in the listings.
239 \begin{lstlisting}[style=sh]
240 ./blds/bld_prepare.sh <os>
242 ./configure --with-single-user
246 Where <os> represents the Operating System supported by \CGG{}, such
247 as centos, fedora, suse, ubuntu, mint, debian.
248 The ``with-single-user'' parameter makes it so.
249 % Make and log build (
250 Check for errors before proceeding.
253 Then just start the application by keying in: \texttt{./cin} in the
254 bin subdirectory OR add a desktop icon by using the appropriate
255 directory to copy the files to, run as \textbf{root}, and edit to
256 correct the directory path. Below are generic directions of how to
259 Then just start the application by keying in: \texttt{./cin} in the
260 bin subdirectory OR add a desktop icon by using the appropriate
261 directory to copy the files to, run as \textbf{root}, and edit to
262 correct the directory path. Below are generic directions of how to
265 \begin{lstlisting}[style=sh]
266 cd /cinelerra_directory_path
267 cp -a image/cin.{svg,xpm} /usr/share/pixmaps/
268 cp -a image/cin.desktop /usr/share/applications/cin.desktop
271 After you have followed the above, in the cin.desktop file, change
272 the \texttt{Exec=cin} line to be
273 \texttt{Exec=<your\_directory\_path>/bin/cin}.
275 The preceding directions for doing a single-user build may work
276 without being root on some distros except for the \texttt{bld\_prepare.sh}
277 and creating the desktop icon. For example in Arch Linux installing without being root
278 works using the following steps:
280 \begin{lstlisting}[style=sh]
281 $ git clone --depth 1 "git://git.cinelerra-gg.org/goodguy/cinelerra.git" cinelerra5
282 $ cd /home/USER/cinelerra5/cinelerra-5.1
284 $ ./configure --prefix=/usr --with-single-user --with-booby
285 $ make 2>&1 | tee /tmp/cin5.log && make install
289 \subsection{Notable Options and Caveats}%
290 \label{sub:notable_options_and_caveats}
293 These procedures and the \CGG{} Infinity software have all been run
294 as \textbf{root} on various home laptops and desktops. This provides
295 the best chance to ensure all works correctly and also allows for
296 handling errors, other problems and potential crashes with the most
297 success. Included in this section are some of the build variations
298 easily available for normal builds.
300 To see the full list of features use:
302 \begin{lstlisting}[style=sh]
305 The default build \index{build} is a system build which uses:
307 \begin{lstlisting}[style=sh]
308 ./configure --without-single-user
311 In the single-user build \index{single-user build}, the target directory is always
312 \texttt{cin}. Because this is also the developer build, constant
313 names are used throughout. However, you can rename files after the
316 If your operating system has issues with the default install to
317 \texttt{/usr/local}, you might have to change the location to
318 \texttt{/usr} for a system build. Then you will have to use:
319 \begin{lstlisting}[style=sh]
320 ./configure --prefix=/usr
323 If you wish to change the default directory for a system build you
324 will have to add the destination directory path on the \texttt{make
325 install} line. For example:
326 \begin{lstlisting}[style=sh]
327 make install DESTDIR=<your selected target directory path>
330 The application name can be set during installation, but defaults to
331 \texttt{cin} so that the GG/Infinity build can coexist with other
332 \CGG{} builds if necessary. To override the default \texttt{cin}
334 \begin{lstlisting}[style=sh]
335 ./configure --with-exec-name=cinelerra
338 The home configuration directory can also be set, but default
339 location is traditionally \texttt{\$HOME/.bcast5}. For example:
341 \begin{lstlisting}[style=sh]
342 ./configure -with-config-dir=/myusername/.bcast5
345 NOTE: when you specify parameters to the configure program, it will
346 create a \texttt{make} file as a consequence. Since in a
347 \texttt{make} file, the \$ is a special character, it must be
348 escaped so in order to represent a \$ as part of an input parameter,
349 it has to be stuttered. That is, you will need \$\$ (2 dollar
350 signs) to represent a single dollar sign.
352 It may be necessary on some distros which have missing or incomplete
353 up-to-date libraries, to build \CGG{} without Ladspa. To do so,
356 \begin{lstlisting}[style=sh]
357 ./configure --prefix=/usr --without-ladspa-build
360 Note that the with-ladspa-dir is the ladspa search path, and
361 exists even if the ladspa build is not selected. This gives you
362 the ability to specify an alternate ladspa system path by
363 utilizing the \texttt{LADSPA\_PATH} environment variable (that is,
364 the default ladspa build is deselected).
366 Note for 32-bit 14.2 Slackware, Debian, Gentoo, Arch, FreeBSD,
367 before running the configure, you will need to set up the following:
369 \begin{lstlisting}[style=sh]
370 export ac_cv_header_xmmintrin_h=no
371 export FFMPEG_EXTRA_CFG=" --disable-vdpau"
375 \subsection{Notes about Building from Git in your Customized Environment}%
376 \label{sub:notes_about_building_from_git_in_your_customized_environment}
381 Getting a build to work in a custom environment is not easy. If you
382 have already installed libraries which are normally in the
383 thirdparty build, getting them to be recognized means you have to
384 install the \textit{devel} version so the header files which match
385 the library interfaces exist. Below is the list of thirdparty
386 builds, but this list may have changed over time.
387 % It's list of Table?
391 \caption{List of thirdparty builds}
392 \label{tab:List_of_thirdparty_builds}
394 \begin{tabular}{m{8em}c}
438 The \textit{yes} means force build and \textit{auto} means probe and
439 use the system version if the build operation is not static. To get
440 your customized build to work, you need to change the probe options
441 for the conflicting libraries from \textit{yes} to \textit{auto}, or
442 even rework the \texttt{configure.ac} script. There may be several
443 libraries which need special treatment.
445 An example of a problem you might encounter with your customized
446 installation is with \texttt{a52dec} which has probes line
447 \texttt{(CHECK\_LIB/CHECK\_HEADERS)} in \texttt{configure.ac}, but
448 \texttt{djbfft} does not. In this case, \texttt{djbfft} is only
449 built because \texttt{a52dec} is built, so if your system has
450 \texttt{a52dec}, set \texttt{a52dec} to auto and see if that
451 problem is solved by retrying the build with:
452 \begin{lstlisting}[style=sh]
453 ./confgure --with-single-user -enable-a52dec=auto .
456 With persistence, you can get results, but it may take several tries
457 to stabilize the build. If you need help, email the \texttt{log}
458 and \texttt{config.log}, which is usually sufficient to determine
461 If you have already installed the \texttt{libfdk\_aac} development
462 package on your computer because you prefer this version over the
463 default aac, you will have to do the following to get this
464 alternative operational. The libfdk\_aac library is not a part of
465 \CGG{} by default because it is not license free.
467 \begin{lstlisting}[style=sh]
468 export FFMPEG_EXTRA_CFG=" --enable-libfdk-aac --enable-nonfree"
469 export EXTRA_LIBS=" -lfdk-aac"
470 for f in `grep -lw aac cinelerra-5.1/ffmpeg/audio/*`; do
471 sed -e 's/\<aac\>/libfdk_aac/' -i $f
476 \subsection{Cloning the Repository for Faster Updates}%
477 \label{sub:cloning_the_repository_for_faster_updates}
481 If you want to avoid downloading the software every time an update
482 is available you need to create a local ``repository'' or repo. The
483 repo is a directory where you first do a \texttt{git clone}. For
484 the initial git clone, set up a local area for the repository
485 storage, referred to as \texttt{<repo\_path>}. The \texttt{git
486 clone} creates a repo named \texttt{cin5} in the
487 \texttt{/<repo\_path>/} directory. This accesses about 530\,MB of
488 repo data, so the device has to have at least that available. The
489 repo path is always a perfect clone of the main repo.
492 \paragraph{Setting up the initial clone}%
493 \label{par:setting_up_the_initial_clone}
495 You may want to add ``\verb|--depth 1|'' before \texttt{cin5}
496 because this will clone faster and is smaller, but has no history.
498 \begin{lstlisting}[style=sh]
500 git clone "git://git.cinelerra-gg.org/goodguy/cinelerra" cin5
502 Cloning into "cin5"...
503 remote: Counting objects: 20032, done.
504 remote: Compressing objects: 100% (11647/11647), done.
505 remote: Total 20032 (delta 11333), reused 16632 (delta 8189)
506 Receiving objects: 100% (20032/20032), 395.29 MiB | 3.26 MiB/s, done.
507 Resolving deltas: 100% (11333/11333), done.
508 Checking connectivity... done.
512 \paragraph{Update an existing repo}%
513 \label{par:update_an_existing_repo}
514 The below shows how you can get updates.
516 \begin{lstlisting}[style=sh]
522 \paragraph{Useful git commands}%
523 \label{par:useful_git_commands}
524 Some other commands that are useful.
526 \begin{lstlisting}[style=sh]
527 git clone "git://git.cinelerra-gg.org/goodguy/cinelerra.git" cin5
528 git pull # pull remote changes to the local version
529 git status # shows changed files
530 git clean -i # interactive clean, use answer 1 to "clean"
534 \subsection{How to Build from a Previous GIT Version}%
535 \label{sub:how_to_build_from_a_previous_git_version}
540 If you have a problem with the current GIT version, you can revert
541 to a previous working version easily. The commands to use will be
542 similar to these next lines which are then explained in more detail.
545 \begin{lstlisting}[style=sh]
546 cd /<path>/cin5 # substitute your repo path name for cin5
547 git log # shows a list of versions depending on history depth specification
548 git checkout <version> # choose a version number as listed
551 The \texttt{git log} command produces a log file with hash values
552 for commit keys to the level specifed if the the depth paramter
554 The hash ids are the commit names to use when you
555 use git checkout. Next is displayed sample output:
557 \begin{lstlisting}[style=nil]
558 delete stray line in last checkin
560 commit 4a90ef3ae46465c0634f81916b79e279e4bd9961
561 Author: Good Guy <good1.2guy@gmail.com>
562 Date: Thu Feb 22 14:56:45 2018 -0700
564 nested clips, big rework and cleanup, sams new icons,
567 commit f87479bd556ea7db4afdd02297fc00977412b873
568 Author: Good Guy <good1.2guy@gmail.com>
569 Date: Sat Feb 17 18:09:22 2018 -0700
572 For the \texttt{git checkout <version>}, you would then keyin the
573 line below for the following results:
575 \begin{lstlisting}[style=nil]
576 git checkout f87479bd556ea7db4afdd02297fc00977412b873
578 Note: checking out 'f87479bd556ea7db4afdd02297fc00977412b873'.
580 You are in 'detached HEAD' state. You can look around, make
581 experimental changes and commit them, and you can discard any
582 commits you make in this state without impacting any branches by
583 performing another checkout.
585 If you want to create a new branch to retain commits you create,
586 you may do so (now or later) by using -b with the checkout command
589 git checkout -b <new-branch-name>
591 HEAD is now at f87479bd... more file size icon updates,
592 and more to followend
595 Later to get the repo back to current, use:
596 \begin{lstlisting}[style=sh]
601 \subsection{Debuggable Single User Build}%
602 \label{sub:debuggable_single_user_build}
603 \index{single-user build}
606 To build from source with full debugging symbols, first build a full
607 static (non\_debug) build as follows but instead of using
608 \texttt{/tmp} substitute your permanent disk path if you want to
611 \begin{lstlisting}[style=sh]
613 git clone --depth 1 "git://git.cinelerra-gg.org/goodguy/cinelerra.git" cinelerra5
614 cp -a /<repo_path>/cinelerra-5.1 /tmp/
615 cd /tmp/cinelerra-5.1
619 Then, to run as a developer in the debugger:
621 \begin{lstlisting}[style=sh]
622 CFLAGS="-O2 -ggdb" make -j8 rebuild_all
628 \subsection{Unbundled Builds}%
629 \label{sub:unbundled_builds}
634 There are some generic build scripts included in the \CGG{} GIT
635 repository for users who want to do unbundled builds with ffmpeg
636 already available on their system. This has been tested on Arch,
637 Ubuntu 18, FreeBSD, Windows10 and Leap 15 (rpm) at the time this
640 The names of the build scripts are: \texttt{arch.bld},
641 \texttt{bsd.bld}, \texttt{deb.bld}, \texttt{rpm.bld}, and
642 \texttt{cygwin.bld}. These scripts are in the \texttt{blds}
643 subdirectory. The \texttt{bsd.bld} should be used with the
644 \texttt{bsd.patch} file in that same directory. The
645 \texttt{cygwin.bld} should be used with the \texttt{cygwin.patch}
646 file in that same directory.
648 The reason that Cin Infinity traditionally uses its own thirdparty builds
649 (bundled builds) is because there are a lot of different distros
650 with varying levels of ffmpeg and other needed thirdparty
651 libraries. However, some users prefer using their current system
652 baseline without another/different copy of ffmpeg.
654 With different levels of the user’s libraries, uncertainty,
655 potential instability, and unknown issues may come up while
656 running \CGG{} and this will make it, for all practical purposes,
657 impossible to diagnose and debug problems or crashes.
659 There may be no help in these cases. You are encouraged to report
660 any errors which potentially originate from Cin Infinity, but if
661 the data indicates alternate library sources, please report the
662 problems to the appropriate maintainers.
664 With the unbundled builds, some features may not be available and
665 no attempt to comment them out has been made. So if you use a
666 pulldown, or pick a render option, or choose something that is not
667 available, it just will not work. For example, unless special
668 options were set up by you, the LV2 audio plugins will not be
669 available. Nor will the codec libzmpeg, the file codec ac3, or
670 DVD creation. The old school file classes will all work, but some
671 of the formats that come with ffmpeg may not because of the way
672 that ffmpeg was installed on your operating system. That is
673 because the \CGG{} included ffmpeg is a known static build and is
674 usually the latest stable/released version. For example, in the
675 current case of Leap 15, libx264 and libx265 are not built in and
676 this can be debilitating; you can always run \texttt{ffmpeg
677 -formats} and \texttt{ffmpeg -codecs} to see what is available
680 \section{Windows 10 with Cygwin for \CGG{} Limited}%
681 \label{sec:ms_windows10}
684 To run \CGG{} on a Windows 10 computer, you will need to have
685 Cygwin installed on your system, along with the \CGG{} static tar
686 and a patched library: libxcb. This setup has been tested with
687 Windows 10, version 1909, on an HP EliteBook 820 at 2.3 GHz.
689 This limited version provides \textit{core} functionality at this
690 time with the standard Windows FFmpeg executable, meaning that
691 specific modifications in FFmpeg needed for \CGG{} are not
692 available. Limited capabilities include only a few render output
693 formats available - for example \textit{mov}, \textit{qt} as
694 \textit{mjpeg}, and \textit{mpeg} for videos and \textit{avi} and
695 \textit{qt} as \textit{s16le} for audio, but not \textit{mkv} or
696 \textit{mp4}. This is due to the fact that several codec and
697 utility libraries are not currently compiled to work with Windows.
699 \subsection*{Installing Cygwin}
700 \label{sec:installing_cygwin}
703 Cygwin is an environment that runs natively on Windows which
704 allows Unix programs to be compiled and run on Windows. With
705 cygwin installed on your Windows 10 computer, you will be able to
706 run \CGG{}. Before installing cygwin, you need to be warned that
707 the Avast anti-virus software kills files necessary for cygwin
708 installation and execution, so you will have to remove it and use
709 alternative anti-virus software (the standard default already
710 included with Windows 10 is Defender). Below are the steps for
714 \item Download cygwin for your 64-bit computer at:
715 \href{https://www.cygwin.com/}{https://www.cygwin.com/}
717 \item Generally just take the defaults as they show up, but the
718 next steps show what comes up.
720 \item When a warning window pops up, click \textit{Yes}.
722 \item Click \textit{Next}.
724 \item Choose \textit{Install from Internet} option and then click
727 \item Choose your desired directory by clicking on Browse
728 button. Choose \textit{All Users (Recommended)} and then click
731 \item Choose the local package directory where you would like your
732 installation files to be placed. Click \textit{Next}.
734 \item Choose \textit{Direct Connection} if you are using Internet
735 with plug and play device. Click \textit{Next}.
737 \item Choose any download site preferably
738 ``cygwin.mirror.constant.com'' and then click \textit{Next}.
740 \item For list of things to install, leave all set to
741 \textit{Default} except these to \textit{Install} instead:
750 This install takes a long time; approximately 2 hours on an
751 EliteBook and requires approximately 20GB storage.
753 \item Finally you will want to have the icons on your desktop
754 (already default) and then click \textit{Finish}.
757 Then to install the \CGG{} tar files, you will need to start a
758 cygwin console terminal from the startup menu as shown here:
759 \texttt{Start $\rightarrow$ Cygwin $\rightarrow$ Cygwin64}
762 \subsection*{Installing \CGG{}}
763 \label{sec:installing_cinelerra}
766 \item Download the tar file
767 \href{https://cinelerra-gg.org/download/testing/libxcb-bld.tar.bz2}{libxcb-bld.tar.bz2}.
769 \item Install libxcb from the tar file -- installs into
770 \texttt{/usr/local} and requires approximately 21MB storage.
771 \begin{lstlisting}[style=sh]
772 tar -C /usr/local -xJf /path/libxcb-bld.tar.bz2
774 The libxcb patch repairs an error (XIOError), which stops
777 \item Download the tar file
778 \href{https://cinelerra-gg.org/download/testing/cygcin-bld.tar.bz2}{cygcin-bld.tar.bz2}.
780 \item Install cygcin from the tar file - this installs into home
781 directory. Note this is cygcin \emph{not} cygwin. You must change the
782 \texttt{path} below to the name of the path where you downloaded
784 \begin{lstlisting}[style=sh]
786 tar -xJf /path/cygcin-bld.tar.bz2
790 This creates \texttt{\~{}/cygcin}, a user build installation of
791 \CGG{} and requires approximately 400MB storage.
793 \paragraph{Running \CGG{}:}
794 You will need to start a cygwin desktop from the startup menu:
796 \item \texttt{Start$\rightarrow$ Cygwin-X $\rightarrow$ Openbox}
798 You should start a console controlling terminal so that you can
801 \item \texttt{Start$\rightarrow$ Cygwin $\rightarrow$ Cygwin64} Terminal
803 This opens a separate window that can survive a cygwin hang and
804 bugs. Without these logs, it is much more difficult to use.
806 \item Type into that console controlling window, the following:
807 \begin{lstlisting}[style=sh]
811 \item Change directories to where \CGG{} is installed:
812 \begin{lstlisting}[style=sh]
813 cd /path/cygcin (NOT cygwin)
817 \begin{lstlisting}[style=sh]
820 which starts up your 4 \CGG{} windows.
823 The most noticeable difference from the Linux versions is that
824 \CGG{} seems to run very slowly on Windows 10. You must be very
825 tolerant and patient to see this work. It can however exhibit
826 astonishing speed when encoding. \CGG{} has to be downgraded
827 significantly due to lack of supported interfaces, codecs (for
828 example h264/h265), and utilities. The only graphics driver is
829 X11 and the only sound driver is pulseaudio. Almost all
830 configurable omissions are applied to this build.
832 \paragraph{\CGG{} build on cygwin from source code:}
835 \item Download and install ffmpeg into /usr/local :
837 download ffmpeg (currently 4.2.2)
838 \begin{lstlisting}[style=sh]
840 tar -xJf /path/ffmpeg-4.2.2.tar.bz2
847 \item Download and install a patched libxcb:
848 \begin{lstlisting}[style=sh]
851 tar -xf /path/libxcb-1.13.tar.bz2
853 patch -p1 < /path/cinelerra-5.1/thirdparty/src/libxcb.patch1
854 patching file configure.ac
855 patching file src/xcb_in.c
861 \item Download cinelerra-gg:
862 \begin{lstlisting}[style=sh]
864 git clone "git://git.cinelerra-gg.org/goodguy/cinelerra.git"
865 cd cinelerra-gg/cinelerra-5.1
867 \item Apply cygwin patch:
868 \begin{lstlisting}[style=sh]
869 patch -p2 < blds/cygwin.patch
871 \item Run the build with:
872 \begin{lstlisting}[style=sh]
877 This produces a directory: /build\_path/cinelerra-gg/cinelerra-5.1/bin
878 which is used to create the cygcin archive.
880 Currently, the targets are not stripped and can be run from gdb.
881 There is only very limited signal handler dmp file support.
882 Running gdb from inside a desktop resident console (not a cygwin64
883 window) will hang cygwin (and cin) when it hits a breakpoint. You
884 must run from an external console window to avoid this issue.
887 \section{Distro with \CGG{} Included}%
888 \label{sec:distro_with_cinelerra_included}
891 There are also some special complete distribution systems
892 available that include \CGG{} for audio and video production
895 \subsection{AV Linux}
898 \textbf{AV Linux} is a downloadable/installable shared snapshot
899 ISO image based on Debian. It provides the user an easy method to
900 get an Audio and Video production workstation without the hassle
901 of trying to find and install all of the usual components
902 themselves. Of course, it includes \CGG{}!
905 \href{http://www.bandshed.net/avlinux/}{homepage of AV Linux}.
907 \subsection{Bodhi Linux Media}
908 \label{sec:Bodhi_Linux}
910 \textbf{Bodhi Linux Media} is a free and open source distribution that
911 comes with a curated list of open source software for digital
912 artists who work with audio, video, includes \CGG{}, games,
913 graphics, animations, physical computing, etc.
916 \href{https://gitlab.com/giuseppetorre/bodhilinuxmedia}{homepage of Bodhi Linux}.
921 \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.
923 Click \href{https://www.elivecd.org/}{Elive} for more information.
925 \section{Cinx and a “Bit” of Confusion}%
926 \label{sec:cinx_and_a_bit_of_confusion}
929 Cinx is the exact same program as Cin. The X (x) represents the
930 roman numeral 10 for 10-bit as opposed to 8-bit standard. The
931 third-party library used for x265 must be specially compiled with
932 \texttt{--bit-depth=10} in order to produce 10-bit rendered
933 output. A cinx version can be built for most other distros if
934 rendering at 10-bit is desirable instead of 8-bit.
936 This build will not be able to output 8-bit depth which means you
937 have to retain the Cin version also.
939 Whatever build ffmpeg is linked to will determine what bit depth
940 it can output. This is why there have to be separate builds. If
941 you install both packages, Cin and CinX, you may get \textit{file
942 conflicts of same file name} --- just continue.
944 Keep in mind that the regular 8-bit version works on 8-bit bytes
945 --- the standard word size for computers, but the 10-bit version
946 has to use 2 words to contain all 10 bits so you can expect
947 rendering to be as much as twice as slow.
949 There is also a 12-bit version for consideration but currently the
950 results are simply the same as 10-bit with padding to make 12-bit
951 so it is of no value.
956 %%% TeX-master: "../CinelerraGG_Manual"