2 \label{cha:Installation}
4 \section{Download Already Built \CGG{}}%
5 \label{sec:download_already_built_cinelerra_gg}
9 \includegraphics[width=1.0\linewidth]{download-distros.png}
10 \caption{Screencast of the website Download page for installing \CGG{} for various O/S.}
11 \label{fig:download-distros}
14 If you prefer to not have to take the time to build \CGG{} Infinity
15 yourself, there are pre-built dynamic or static binaries for various
16 versions of Ubuntu, Mint, Suse, Fedora, Debian, Centos, Arch, and
17 Slackware linux as well as Gentoo and FreeBSD. If you do want to build it yourself so that
18 you get the added benefit of the latest checked in changes, please reference
19 ~\ref{sec:How_to_build}.
21 A Windows 10 version installation is described in~\ref{sec:ms_windows10}. There are also 32-bit i686 Ubuntu, Debian,
22 and Slackware versions available. These are updated on a fairly
23 regular basis as long as significant code changes have been made.
24 They are in subdirectories of:
27 \item \href{https://cinelerra-gg.org/download/tars}{https://cinelerra-gg.org/download/tars}
28 \item \href{https://cinelerra-gg.org/download/pkgs}{https://cinelerra-gg.org/download/pkgs}
31 The \textbf{tars} directory contains single-user static builds for
34 This is the recommended usage of \CGG{} because all of the files
35 will exist in a single directory. Generally all of the necessary
36 libraries are built into the static build, but in some cases you may
37 have to install another library that is being called for.
39 To install the single user builds, download the designated tarball
40 from the \texttt{./tars} subdirectory and unpack as indicated below:
42 \begin{lstlisting}[style=sh]
46 tar -xJf /src/path/cinelerra-5.1-*.txz # for the *,
47 # 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} 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}
77 These are generic build instructions for building \CGG{} Infinity.
78 Known to work on Ubuntu, Mint, OpenSuse, Fedora, Debian, Centos,
79 Arch, Slackware, and Gentoo. It has not been tested on every
80 single possible distro yet so you might expect to have to make
81 some minor changes. Also works on a somewhat limited basis on
82 FreeBSD and Windows 10 with the bsd.patch for FreeBSD and the
83 cygwin.patch for Windows 10.
85 Alternatively, there are some pre-built dynamic or static binaries
86 which are updated on a fairly regular basis (as long as code changes
87 have been made) available at the link below.
89 \href{https://cinelerra-gg.org/download/}{https://cinelerra-gg.org/download/}
92 There are 2 kinds of builds, the default system-build and a
93 single-user build. A system build has results which are installed
94 to the system. The majority of the files are installed in the
95 standard system paths, but some customization is possible. The
96 single user build allows for running completely out of a local
97 user directory so it doesn't affect the system.
99 We recommend the single-user version when possible. It makes it
100 very easy to install a new version without having to delete the
101 older version in case you want it for backup -- once you are happy
102 with the new version, all you have to do is delete the entire old
103 directory path. Another reason for using single-user is that if
104 you install a new Operating System version and if you have \CGG{}
105 on separate disk space that is preserved, you won't have to
106 reinstall \CGG{}. It is also convenient for the purpose of having
107 the ability to interrupt or to see any possible error messages, if
108 you start the application from a terminal window command line
109 where you will have more control to catch problems. All that
110 said, the system builds can be useful in a university lab setting
111 where there are possibly multiple users, or multiple versions.
113 There are two notable differences between standard views
114 of \CGG{} and this implementation for the system builds. Both of
115 these can be configured during installation. The differences make
116 it possible to have several different versions installed without
117 having them interfere with each other.
120 \item application name can be set during a build but defaults
122 \item the home configuration directory can also be set and
123 traditionally defaults to: \texttt{\$HOME/.bcast5}
127 \subsection{The system build}
128 \label{sec:system-build}
130 To do a system build, you should read the file
131 \texttt{README} that is at the top level after you get the source.
134 \item You need about 6.0 \,GB of disk storage to operate a build and
135 you need to have \textit{git} installed.
137 \item Obviously in order to install into the system, you must run as
140 \item The \textit{git:} step has to download many files (approx
141 130\,MB) so allow time. When decompressed this will expand to
144 \item Run the following commands (this takes awhile):
146 \begin{lstlisting}[style=sh]
147 # This is where you need the 6.0GB of disk space:
149 git clone --depth 1 "git://git.cinelerra-gg.org/goodguy/cinelerra.git" cinelerra5
150 # Change to the cloned directory:
151 cd cinelerra5/cinelerra-5.1
153 NOTE: if your system has never had \CGG{} Infinity installed, you
154 will have to make sure you have all of the compilers and libraries
155 necessary. So on the very first build you should run:
157 \begin{lstlisting}[style=sh]
158 ./blds/bld_prepare.sh <os> # where <os> represents the
159 # Operating System of
160 # centos, fedora, suse, ubuntu, mint, debian.
162 ./configure --prefix=/usr # optional parameters can be added here
163 make 2>&1 | tee log # make and log the build
166 \texttt{bld\_prepare.sh} does not work for Arch Linux or Gentoo,
167 so we have to install the dependencies
168 manually. \texttt{README.arch} or \texttt{README.gentoo}, which
169 contain the list of dependencies, can be found at:
171 \item \href{https://cinelerra-gg.org/download/README.arch}{https://cinelerra-gg.org/download/README.arch}
172 \item \href{https://cinelerra-gg.org/download/README.gentoo}{https://cinelerra-gg.org/download/README.gentoo}
175 \item Check for obvious build errors:
176 \begin{lstlisting}[style=sh]
177 grep "\*\*\*.*error" -ai log
179 If this reports errors and you need assistance or you think
180 improvements can be made to the builds, email the log which is
182 \href{mailto:cin@lists.cinelerra-gg.org}{cin@lists.cinelerra-gg.org}
183 \begin{lstlisting}[style=sh]
184 /<build_path>/cinelerra5/cinelerra-5.1/log
187 \item If there are no build errors, finally just run:
188 \begin{lstlisting}[style=sh]
191 Where <os> represents the Operating System supported by \CGG{}, such
192 as centos, fedora, suse, ubuntu, mint, debian.
193 The ``with-single-user'' parameter makes it so.
194 % Make and log build (
195 Check for errors before proceeding.
198 \item If it all worked, you are all setup. Just click on the \CGG{}
203 \subsection{The single-user build}
204 \label{sec:single-user-build}
206 To do a single-user build, read the file \texttt{README} that is at
207 the top level after you get the source.
210 \item You need at least 6\,GB of disk storage to operate a build +
211 you need to have “\texttt{git}” installed.
213 \item Recommend you build and run as \textbf{root}, just to avoid
214 permission issues initially.
215 \item The \textit{git} step has to download many files (approx
216 130\,MB) so allow time.
218 \item Run the following commands (this takes awhile):
219 \begin{lstlisting}[style=sh]
220 # This is where you need the 6GB of disk space
222 git clone --depth 1 "git://git.cinelerra-gg.org/goodguy/cinelerra.git" cinelerra5
223 # Toplevel directory:
224 cd cinelerra5/cinelerra-5.1
228 NOTE: if your system has never had \CGG{} Infinity installed, you
229 will have to make sure all the compilers and libraries necessary are
230 installed. So on the very first build you should run as
233 % FIXME No novels in the listings.
234 \begin{lstlisting}[style=sh]
235 ./blds/bld_prepare.sh <os>
237 ./configure --with-single-user
241 Where <os> represents the Operating System supported by \CGG{}, such
242 as centos, fedora, suse, ubuntu, mint, debian.
243 The ``with-single-user'' parameter makes it so.
244 % Make and log build (
245 Check for errors before proceeding.
248 Then just start the application by keying in: \texttt{./cin} in the
249 bin subdirectory OR add a desktop icon by using the appropriate
250 directory to copy the files to, run as \textbf{root}, and edit to
251 correct the directory path. Below are generic directions of how to
254 Then just start the application by keying in: \texttt{./cin} in the
255 bin subdirectory OR add a desktop icon by using the appropriate
256 directory to copy the files to, run as \textbf{root}, and edit to
257 correct the directory path. Below are generic directions of how to
260 \begin{lstlisting}[style=sh]
261 cd /cinelerra_directory_path
262 cp -a image/cin.{svg,xpm} /usr/share/pixmaps/
263 cp -a image/cin.desktop /usr/share/applications/cin.desktop
266 After you have followed the above, in the cin.desktop file, change
267 the \texttt{Exec=cin} line to be
268 \texttt{Exec=<your\_directory\_path>/bin/cin}.
270 The preceding directions for doing a single-user build may work
271 without being root on some distros except for the \texttt{bld\_prepare.sh}
272 and creating the desktop icon.
275 \subsection{Notable Options and Caveats}%
276 \label{sub:notable_options_and_caveats}
278 These procedures and the \CGG{} Infinity software have all been run
279 as \textbf{root} on various home laptops and desktops. This provides
280 the best chance to ensure all works correctly and also allows for
281 handling errors, other problems and potential crashes with the most
282 success. Included in this section are some of the build variations
283 easily available for normal builds.
285 To see the full list of features use:
287 \begin{lstlisting}[style=sh]
290 The default build is a system build which uses:
292 \begin{lstlisting}[style=sh]
293 ./configure --without-single-user
296 In the single-user build, the target directory is always
297 \texttt{cin}. Because this is also the developer build, constant
298 names are used throughout. However, you can rename files after the
301 If your operating system has issues with the default install to
302 \texttt{/usr/local}, you might have to change the location to
303 \texttt{/usr} for a system build. Then you will have to use:
304 \begin{lstlisting}[style=sh]
305 ./configure --prefix=/usr
308 If you wish to change the default directory for a system build you
309 will have to add the destination directory path on the \texttt{make
310 install} line. For example:
311 \begin{lstlisting}[style=sh]
312 make install DESTDIR=<your selected target directory path>
315 The application name can be set during installation, but defaults to
316 \texttt{cin} so that the GG/Infinity build can coexist with other
317 \CGG{} builds if necessary. To override the default \texttt{cin}
319 \begin{lstlisting}[style=sh]
320 ./configure --with-exec-name=cinelerra
323 The home configuration directory can also be set, but default
324 location is traditionally \texttt{\$HOME/.bcast5}. For example:
326 \begin{lstlisting}[style=sh]
327 ./configure -with-config-dir=/myusername/.bcast5
330 NOTE: when you specify parameters to the configure program, it will
331 create a \texttt{make} file as a consequence. Since in a
332 \texttt{make} file, the \$ is a special character, it must be
333 escaped so in order to represent a \$ as part of an input parameter,
334 it has to be stuttered. That is, you will need \$\$ (2 dollar
335 signs) to represent a single dollar sign.
337 It may be necessary on some distros which have missing or incomplete
338 up-to-date libraries, to build \CGG{} without Ladspa. To do so,
341 \begin{lstlisting}[style=sh]
342 ./configure --prefix=/usr --without-ladspa-build
345 Note that the with-ladspa-dir is the ladspa search path, and
346 exists even if the ladspa build is not selected. This gives you
347 the ability to specify an alternate ladspa system path by
348 utilizing the \texttt{LADSPA\_PATH} environment variable (that is,
349 the default ladspa build is deselected).
351 Note for 32-bit 14.2 Slackware, Debian, Gentoo, Arch, FreeBSD,
352 before running the configure, you will need to set up the following:
354 \begin{lstlisting}[style=sh]
355 export ac_cv_header_xmmintrin_h=no
356 export FFMPEG_EXTRA_CFG=" --disable-vdpau"
360 \subsection{Notes about Building from Git in your Customized Environment}%
361 \label{sub:notes_about_building_from_git_in_your_customized_environment}
363 Getting a build to work in a custom environment is not easy. If you
364 have already installed libraries which are normally in the
365 thirdparty build, getting them to be recognized means you have to
366 install the \textit{devel} version so the header files which match
367 the library interfaces exist. Below is the list of thirdparty
368 builds, but this list may have changed over time.
369 % It's list of Table?
373 \caption{List of thirdparty builds}
374 \label{tab:List_of_thirdparty_builds}
376 \begin{tabular}{m{8em}c}
420 The \textit{yes} means force build and \textit{auto} means probe and
421 use the system version if the build operation is not static. To get
422 your customized build to work, you need to change the probe options
423 for the conflicting libraries from \textit{yes} to \textit{auto}, or
424 even rework the \texttt{configure.ac} script. There may be several
425 libraries which need special treatment.
427 An example of a problem you might encounter with your customized
428 installation is with \texttt{a52dec} which has probes line
429 \texttt{(CHECK\_LIB/CHECK\_HEADERS)} in \texttt{configure.ac}, but
430 \texttt{djbfft} does not. In this case, \texttt{djbfft} is only
431 built because \texttt{a52dec} is built, so if your system has
432 \texttt{a52dec}, set \texttt{a52dec} to auto and see if that
433 problem is solved by retrying the build with:
434 \begin{lstlisting}[style=sh]
435 ./confgure --with-single-user -enable-a52dec=auto .
438 With persistence, you can get results, but it may take several tries
439 to stabilize the build. If you need help, email the \texttt{log}
440 and \texttt{config.log}, which is usually sufficient to determine
443 If you have already installed the \texttt{libfdk\_aac} development
444 package on your computer because you prefer this version over the
445 default aac, you will have to do the following to get this
446 alternative operational. The libfdk\_aac library is not a part of
447 \CGG{} by default because it is not license free.
449 \begin{lstlisting}[style=sh]
450 export FFMPEG_EXTRA_CFG=" --enable-libfdk-aac --enable-nonfree"
451 export EXTRA_LIBS=" -lfdk-aac"
452 for f in `grep -lw aac cinelerra-5.1/ffmpeg/audio/*`; do
453 sed -e 's/\<aac\>/libfdk_aac/' -i $f
458 \subsection{Cloning the Repository for Faster Updates}%
459 \label{sub:cloning_the_repository_for_faster_updates}
461 If you want to avoid downloading the software every time an update
462 is available you need to create a local ``repository'' or repo. The
463 repo is a directory where you first do a \texttt{git clone}. For
464 the initial git clone, set up a local area for the repository
465 storage, referred to as \texttt{<repo\_path>}. The \texttt{git
466 clone} creates a repo named \texttt{cin5} in the
467 \texttt{/<repo\_path>/} directory. This accesses about 530\,MB of
468 repo data, so the device has to have at least that available. The
469 repo path is always a perfect clone of the main repo.
472 \paragraph{Setting up the initial clone}%
473 \label{par:setting_up_the_initial_clone}
475 You may want to add ``\verb|--depth 1|'' before \texttt{cin5}
476 because this will clone faster and is smaller, but has no history.
478 \begin{lstlisting}[style=sh]
480 git clone "git://git.cinelerra-gg.org/goodguy/cinelerra" cin5
482 Cloning into "cin5"...
483 remote: Counting objects: 20032, done.
484 remote: Compressing objects: 100% (11647/11647), done.
485 remote: Total 20032 (delta 11333), reused 16632 (delta 8189)
486 Receiving objects: 100% (20032/20032), 395.29 MiB | 3.26 MiB/s, done.
487 Resolving deltas: 100% (11333/11333), done.
488 Checking connectivity... done.
492 \paragraph{Update an existing repo}%
493 \label{par:update_an_existing_repo}
494 The below shows how you can get updates.
496 \begin{lstlisting}[style=sh]
502 \paragraph{Useful git commands}%
503 \label{par:useful_git_commands}
504 Some other commands that are useful.
506 \begin{lstlisting}[style=sh]
507 git clone "git://git.cinelerra-gg.org/goodguy/cinelerra.git" cin5
508 git pull # pull remote changes to the local version
509 git status # shows changed files
510 git clean -i # interactive clean, use answer 1 to "clean"
514 \subsection{How to Build from a Previous GIT Version}%
515 \label{sub:how_to_build_from_a_previous_git_version}
517 If you have a problem with the current GIT version, you can revert
518 to a previous working version easily. The commands to use will be
519 similar to these next lines which are then explained in more detail.
522 \begin{lstlisting}[style=sh]
523 cd /<path>/cin5 # substitute your repo path name for cin5
524 git log # shows a list of versions depending on history depth specification
525 git checkout <version> # choose a version number as listed
528 The \texttt{git log} command produces a log file with hash values
529 for commit keys to the level specifed if the the depth paramter
531 The hash ids are the commit names to use when you
532 use git checkout. Next is displayed sample output:
534 \begin{lstlisting}[style=nil]
535 delete stray line in last checkin
537 commit 4a90ef3ae46465c0634f81916b79e279e4bd9961
538 Author: Good Guy <good1.2guy@gmail.com>
539 Date: Thu Feb 22 14:56:45 2018 -0700
541 nested clips, big rework and cleanup, sams new icons,
544 commit f87479bd556ea7db4afdd02297fc00977412b873
545 Author: Good Guy <good1.2guy@gmail.com>
546 Date: Sat Feb 17 18:09:22 2018 -0700
549 For the \texttt{git checkout <version>}, you would then keyin the
550 line below for the following results:
552 \begin{lstlisting}[style=nil]
553 git checkout f87479bd556ea7db4afdd02297fc00977412b873
555 Note: checking out 'f87479bd556ea7db4afdd02297fc00977412b873'.
557 You are in 'detached HEAD' state. You can look around, make
558 experimental changes and commit them, and you can discard any
559 commits you make in this state without impacting any branches by
560 performing another checkout.
562 If you want to create a new branch to retain commits you create,
563 you may do so (now or later) by using -b with the checkout command
566 git checkout -b <new-branch-name>
568 HEAD is now at f87479bd... more file size icon updates,
569 and more to followend
572 Later to get the repo back to current, use:
573 \begin{lstlisting}[style=sh]
578 \subsection{Debuggable Single User Build}%
579 \label{sub:debuggable_single_user_build}
581 To build from source with full debugging symbols, first build a full
582 static (non\_debug) build as follows but instead of using
583 \texttt{/tmp} substitute your permanent disk path if you want to
586 \begin{lstlisting}[style=sh]
588 git clone --depth 1 "git://git.cinelerra-gg.org/goodguy/cinelerra.git" cinelerra5
589 cp -a /<repo_path>/cinelerra-5.1 /tmp/
590 cd /tmp/cinelerra-5.1
594 Then, to run as a developer in the debugger:
596 \begin{lstlisting}[style=sh]
597 CFLAGS="-O2 -ggdb" make -j8 rebuild_all
603 \subsection{Unbundled Builds}%
604 \label{sub:unbundled_builds}
606 There are some generic build scripts included in the \CGG{} GIT
607 repository for users who want to do unbundled builds with ffmpeg
608 already available on their system. This has been tested on Arch,
609 Ubuntu 18, FreeBSD, Windows10 and Leap 15 (rpm) at the time this
612 The names of the build scripts are: \texttt{arch.bld},
613 \texttt{bsd.bld}, \texttt{deb.bld}, \texttt{rpm.bld}, and
614 \texttt{cygwin.bld}. These scripts are in the \texttt{blds}
615 subdirectory. The \texttt{bsd.bld} should be used with the
616 \texttt{bsd.patch} file in that same directory. The
617 \texttt{cygwin.bld} should be used with the \texttt{cygwin.patch}
618 file in that same directory.
620 The reason that Cin Infinity traditionally uses its own thirdparty builds
621 (bundled builds) is because there are a lot of different distros
622 with varying levels of ffmpeg and other needed thirdparty
623 libraries. However, some users prefer using their current system
624 baseline without another/different copy of ffmpeg.
626 With different levels of the user’s libraries, uncertainty,
627 potential instability, and unknown issues may come up while
628 running \CGG{} and this will make it, for all practical purposes,
629 impossible to diagnose and debug problems or crashes.
631 There may be no help in these cases. You are encouraged to report
632 any errors which potentially originate from Cin Infinity, but if
633 the data indicates alternate library sources, please report the
634 problems to the appropriate maintainers.
636 With the unbundled builds, some features may not be available and
637 no attempt to comment them out has been made. So if you use a
638 pulldown, or pick a render option, or choose something that is not
639 available, it just will not work. For example, unless special
640 options were set up by you, the LV2 audio plugins will not be
641 available. Nor will the codec libzmpeg, the file codec ac3, or
642 DVD creation. The old school file classes will all work, but some
643 of the formats that come with ffmpeg may not because of the way
644 that ffmpeg was installed on your operating system. That is
645 because the \CGG{} included ffmpeg is a known static build and is
646 usually the latest stable/released version. For example, in the
647 current case of Leap 15, libx264 and libx265 are not built in and
648 this can be debilitating; you can always run \texttt{ffmpeg
649 -formats} and \texttt{ffmpeg -codecs} to see what is available
652 \section{Windows 10 with Cygwin for \CGG{} Limited}%
653 \label{sec:ms_windows10}
655 To run \CGG{} on a Windows 10 computer, you will need to have
656 Cygwin installed on your system, along with the \CGG{} static tar
657 and a patched library: libxbc. This setup has been tested with
658 Windows 10, version 1909, on an HP EliteBook 820 at 2.3 GHz.
660 This limited version provides \textit{core} functionality at this
661 time with the standard Windows FFmpeg executable, meaning that
662 specific modifications in FFmpeg needed for \CGG{} are not
663 available. Limited capabilities include only a few render output
664 formats available - for example \textit{mov}, \textit{qt} as
665 \textit{mjpeg}, and \textit{mpeg} for videos and \textit{avi} and
666 \textit{qt} as \textit{s16le} for audio, but not \textit{mkv} or
667 \textit{mp4}. This is due to the fact that several codec and
668 utility libraries are not currently compiled to work with Windows.
670 \subsection*{Installing Cygwin}
671 \label{sec:installing_cygwin}
673 Cygwin is an environment that runs natively on Windows which
674 allows Unix programs to be compiled and run on Windows. With
675 cygwin installed on your Windows 10 computer, you will be able to
676 run \CGG{}. Before installing cygwin, you need to be warned that
677 the Avast anti-virus software kills files necessary for cygwin
678 installation and execution, so you will have to remove it and use
679 alternative anti-virus software (the standard default already
680 included with Windows 10 is Defender). Below are the steps for
684 \item Download cygwin for your 64-bit computer at:
685 \href{https://www.cygwin.com/}{https://www.cygwin.com/}
687 \item Generally just take the defaults as they show up, but the
688 next steps show what comes up.
690 \item When a warning window pops up, click \textit{Yes}.
692 \item Click \textit{Next}.
694 \item Choose \textit{Install from Internet} option and then click
697 \item Choose your desired directory by clicking on Browse
698 button. Choose \textit{All Users (Recommended)} and then click
701 \item Choose the local package directory where you would like your
702 installation files to be placed. Click \textit{Next}.
704 \item Choose \textit{Direct Connection} if you are using Internet
705 with plug and play device. Click \textit{Next}.
707 \item Choose any download site preferably
708 ``cygwin.mirror.constant.com'' and then click \textit{Next}.
710 \item For list of things to install, leave all set to
711 \textit{Default} except these to \textit{Install} instead:
720 This install takes a long time; approximately 2 hours on an
721 EliteBook and requires approximately 20GB storage.
723 \item Finally you will want to have the icons on your desktop
724 (already default) and then click \textit{Finish}.
727 Then to install the \CGG{} tar files, you will need to start a
728 cygwin console terminal from the startup menu as shown here:
729 \texttt{Start $\rightarrow$ Cygwin $\rightarrow$ Cygwin64}
732 \subsection*{Installing \CGG{}}
733 \label{sec:installing_cinelerra}
736 \item Download the tar file
737 \href{https://cinelerra-gg.org/download/testing/libxcb-bld.tar.bz2}{libxcb-bld.tar.bz2}.
739 \item Install libxbc from the tar file -- installs into
740 \texttt{/usr/local} and requires approximately 21MB storage.
741 \begin{lstlisting}[style=sh]
742 tar -C /usr/local -xJf /path/libxcb-bld.tar.bz2
744 The libxcb path repairs an error (XIOError), which stops
747 \item Download the tar file
748 \href{https://cinelerra-gg.org/download/testing/cygcin-bld.tar.bz2}{cygcin-bld.tar.bz2}.
750 \item Install cygcin from the tar file - this installs into home
751 directory. Note this is cygcin \emph{not} cygwin. You must change the
752 \texttt{path} below to the name of the path where you downloaded
754 \begin{lstlisting}[style=sh]
756 tar -xJf /path/cygcin-bld.tar.bz2
760 This creates \texttt{\~{}/cygcin}, a user build installation of
761 \CGG{} and requires approximately 400MB storage.
763 \paragraph{Running \CGG{}:}
764 You will need to start a cygwin desktop from the startup menu:
766 \item \texttt{Start$\rightarrow$ Cygwin-X $\rightarrow$ Openbox}
768 You should start a console controlling terminal so that you can
771 \item \texttt{Start$\rightarrow$ Cygwin $\rightarrow$ Cygwin64} Terminal
773 This opens a separate window that can survive a cygwin hang and
774 bugs. Without these logs, it is much more difficult to use.
776 \item Type into that console controlling window, the following:
777 \begin{lstlisting}[style=sh]
781 \item Change directories to where \CGG{} is installed:
782 \begin{lstlisting}[style=sh]
783 cd /path/cygcin (NOT cygwin)
787 \begin{lstlisting}[style=sh]
790 which starts up your 4 \CGG{} windows.
793 The most noticeable difference from the Linux versions is that
794 \CGG{} seems to run very slowly on Windows 10. You must be very
795 tolerant and patient to see this work. It can however exhibit
796 astonishing speed when encoding. \CGG{} has to be downgraded
797 significantly due to lack of supported interfaces, codecs (for
798 example h264/h265), and utilities. The only graphics driver is
799 X11 and the only sound driver is pulseaudio. Almost all
800 configurable omissions are applied to this build.
802 \paragraph{\CGG{} build on cygwin from source code:}
805 \item Download and install ffmpeg into /usr/local :
807 download ffmpeg (currently 4.2.2)
808 \begin{lstlisting}[style=sh]
810 tar -xJf /path/ffmpeg-4.2.2.tar.bz2
817 \item Download and install a patched libxcb:
818 \begin{lstlisting}[style=sh]
821 tar -xf /path/libxcb-1.13.tar.bz2
823 patch -p1 < /path/cinelerra-5.1/thirdparty/src/libxcb.patch1
824 patching file configure.ac
825 patching file src/xcb_in.c
831 \item Download cinelerra-gg:
832 \begin{lstlisting}[style=sh]
834 git clone "git://git.cinelerra-gg.org/goodguy/cinelerra.git"
835 cd cinelerra-gg/cinelerra-5.1
837 \item Apply cygwin patch:
838 \begin{lstlisting}[style=sh]
839 patch -p2 < blds/cygwin.patch
841 \item Run the build with:
842 \begin{lstlisting}[style=sh]
847 This produces a directory: /build\_path/cinelerra-gg/cinelerra-5.1/bin
848 which is used to create the cygcin archive.
850 Currently, the targets are not stripped and can be run from gdb.
851 There is only very limited signal handler dmp file support.
852 Running gdb from inside a desktop resident console (not a cygwin64
853 window) will hang cygwin (and cin) when it hits a breakpoint. You
854 must run from an external console window to avoid this issue.
857 \section{Distribution Systems with \CGG{} Included}%
858 \label{sec:distribution_systems_with_cinelerra_included}
860 There are also some special complete distribution systems
861 available that include \CGG{} for audio and video production
864 \subsection{AV Linux}
867 \textbf{AV Linux} is a downloadable/installable shared snapshot
868 ISO image based on Debian. It provides the user an easy method to
869 get an Audio and Video production workstation without the hassle
870 of trying to find and install all of the usual components
871 themselves. Of course, it includes \CGG{}!
874 \href{http://www.bandshed.net/avlinux/}{homepage of AV Linux}.
876 \subsection{Bodhi Linux Media}
877 \label{sec:Bodhi_Linux}
879 \textbf{Bodhi Linux Media} is a free and open source distribution that
880 comes with a curated list of open source software for digital
881 artists who work with audio, video, includes \CGG{}, games,
882 graphics, animations, physical computing, etc.
885 \href{https://gitlab.com/giuseppetorre/bodhilinuxmedia}{homepage of Bodhi Linux}.
890 \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.
892 Click \href{https://www.elivecd.org/}{Elive} for more information.
894 \section{Cinx and a “Bit” of Confusion}%
895 \label{sec:cinx_and_a_bit_of_confusion}
897 Cinx is the exact same program as Cin. The X (x) represents the
898 roman numeral 10 for 10-bit as opposed to 8-bit standard. The
899 third-party library used for x265 must be specially compiled with
900 \texttt{--bit-depth=10} in order to produce 10-bit rendered
901 output. A cinx version can be built for most other distros if
902 rendering at 10-bit is desirable instead of 8-bit.
904 This build will not be able to output 8-bit depth which means you
905 have to retain the Cin version also.
907 Whatever build ffmpeg is linked to will determine what bit depth
908 it can output. This is why there have to be separate builds. If
909 you install both packages, Cin and CinX, you may get \textit{file
910 conflicts of same file name} --- just continue.
912 Keep in mind that the regular 8-bit version works on 8-bit bytes
913 --- the standard word size for computers, but the 10-bit version
914 has to use 2 words to contain all 10 bits so you can expect
915 rendering to be as much as twice as slow.
917 There is also a 12-bit version for consideration but currently the
918 results are simply the same as 10-bit with padding to make 12-bit
919 so it is of no value.
924 %%% TeX-master: "../CinelerraGG_Manual"