2 \label{cha:Installation}
3 \section{How to Build \CGG{} from Developer's Git Repository}%
4 \label{sec:How_to_build}
6 These are generic build instructions for building \CGG{} Infinity.
7 Known to work on Ubuntu, Mint, OpenSuse, Fedora, Debian, Centos,
8 Arch, Slackware, and Gentoo. It has not been tested on every
9 single possible distro yet so you might expect to have to make
10 some minor changes. Also works on a somewhat limited basis on
11 FreeBSD and Windows 10 with the bsd.patch for FreeBSD and the
12 cygwin.patch for Windows 10.
14 Alternatively, there are some pre-built dynamic or static binaries
15 which are updated on a fairly regular basis (as long as code changes
16 have been made) available at the link below.
18 \href{https://cinelerra-gg.org/download/}{https://cinelerra-gg.org/download/}
21 There are 2 kinds of builds, the default system-build and a
22 single-user build. A system build has results which are installed
23 to the system. The majority of the files are installed in the
24 standard system paths, but some customization is possible. The
25 single user build allows for running completely out of a local
26 user directory so it doesn't affect the system.
28 We recommend the single-user version when possible. It makes it
29 very easy to install a new version without having to delete the
30 older version in case you want it for backup -- once you are happy
31 with the new version, all you have to do is delete the entire old
32 directory path. Another reason for using single-user is that if
33 you install a new Operating System version and if you have \CGG{}
34 on separate disk space that is preserved, you won't have to
35 reinstall \CGG{}. It is also convenient for the purpose of having
36 the ability to interrupt or to see any possible error messages, if
37 you start the application from a terminal window command line
38 where you will have more control to catch problems. All that
39 said, the system builds can be useful in a university lab setting
40 where there are possibly multiple users, or multiple versions.
42 There are two notable differences between \textit{standard} views
43 of \CGG{} and this implementation for the system builds. Both of
44 these can be configured during installation. The differences make
45 it possible to have several different versions installed without
46 having them \textit{walk} on each other.
49 \item application name can be set during installation and defaults
51 \item the home configuration directory can also be set and
52 traditionally defaults to: \texttt{\$HOME/.bcast5}
56 \subsection{The system build}
57 \label{sec:system-build}
59 To do a system build, you should read the file
60 \texttt{README} that is at the top level after you get the source.
63 \item You need about 6.0 \,GB of disk storage to operate a build and
64 you need to have \textit{git} installed.
66 \item Obviously in order to install into the system, you must run as
69 \item The \textit{git:} step has to download many files (approx
70 130\,MB) so allow time. When decompressed this will expand to
73 \item Run the following commands (this takes awhile):
75 \begin{lstlisting}[style=sh]
76 # This is where you need the 6.0GB of disk space:
78 git clone --depth 1 "git://git.cinelerra-gg.org/goodguy/cinelerra.git" cinelerra5
79 # Change to the cloned directory:
80 cd cinelerra5/cinelerra-5.1
82 NOTE: if your system has never had \CGG{} Infinity installed, you
83 will have to make sure you have all of the compilers and libraries
84 necessary. So on the very first build you should run:
86 \begin{lstlisting}[style=sh]
87 ./blds/bld_prepare.sh <os> # where <os> represents the
89 # centos, fedora, suse, ubuntu, mint, debian.
91 ./configure --prefix=/usr # optional parameters can be added here
92 make 2>&1 | tee log # make and log the build
95 \texttt{bld\_prepare.sh} does not work for Arch Linux or Gentoo,
96 so we have to install the dependencies
97 manually. \texttt{README.arch} or \texttt{README.gentoo}, which
98 contain the list of dependencies, can be found at:
100 \item \href{https://cinelerra-gg.org/download/README.arch}{https://cinelerra-gg.org/download/README.arch}
101 \item \href{https://cinelerra-gg.org/download/README.gentoo}{https://cinelerra-gg.org/download/README.gentoo}
104 \item Check for obvious build errors:
105 \begin{lstlisting}[style=sh]
106 grep "\*\*\*.*error" -ai log
108 If this reports errors and you need assistance or you think
109 improvements can be made to the builds, email the log which is
111 \href{mailto:cin@lists.cinelerra-gg.org}{cin@lists.cinelerra-gg.org}
112 \begin{lstlisting}[style=sh]
113 /<build_path>/cinelerra5/cinelerra-5.1/log
116 \item If there are no build errors, finally just run:
117 \begin{lstlisting}[style=sh]
120 Where <os> represents the Operating System supported by \CGG{}, such
121 as centos, fedora, suse, ubuntu, mint, debian.
122 The ``with-single-user'' parameter makes it so.
123 % Make and log build (
124 Check for errors before proceeding.
127 \item If it all worked, you are all setup. Just click on the \CGG{}
132 \subsection{The single-user build}
133 \label{sec:single-user-build}
135 To do a single-user build, read the file \texttt{README} that is at
136 the top level after you get the source.
139 \item You need at least 6\,GB of disk storage to operate a build +
140 you need to have β\texttt{git}β installed.
142 \item Recommend you build and run as \textbf{root}, just to avoid
143 permission issues initially.
144 \item The \textit{git} step has to download many files (approx
145 130\,MB) so allow time.
147 \item Run the following commands (this takes awhile):
148 \begin{lstlisting}[style=sh]
149 # This is where you need the 6GB of disk space
151 git clone --depth 1 "git://git.cinelerra-gg.org/goodguy/cinelerra.git" cinelerra5
152 # Toplevel directory:
153 cd cinelerra5/cinelerra-5.1
157 NOTE: if your system has never had \CGG{} Infinity installed, you
158 will have to make sure all the compilers and libraries necessary are
159 installed. So on the very first build you should run as
162 % FIXME No novels in the listings.
163 \begin{lstlisting}[style=sh]
164 ./blds/bld_prepare.sh <os>
166 ./configure --with-single-user
170 Where <os> represents the Operating System supported by \CGG{}, such
171 as centos, fedora, suse, ubuntu, mint, debian.
172 The ``with-single-user'' parameter makes it so.
173 % Make and log build (
174 Check for errors before proceeding.
177 Then just start the application by keying in: \texttt{./cin} in the
178 bin subdirectory OR add a desktop icon by using the appropriate
179 directory to copy the files to, run as \textbf{root}, and edit to
180 correct the directory path. Below are generic directions of how to
183 Then just start the application by keying in: \texttt{./cin} in the
184 bin subdirectory OR add a desktop icon by using the appropriate
185 directory to copy the files to, run as \textbf{root}, and edit to
186 correct the directory path. Below are generic directions of how to
189 \begin{lstlisting}[style=sh]
190 cd /cinelerra_directory_path
191 cp -a image/cin.{svg,xpm} /usr/share/pixmaps/
192 cp -a image/cin.desktop /usr/share/applications/cin.desktop
195 After you have followed the above, in the cin.desktop file, change
196 the \texttt{Exec=cin} line to be
197 \texttt{Exec=<your\_directory\_path>/bin/cin}.
199 The preceding directions for doing a single-user build have been
200 meticulously followed to build and run on a newly installed ubuntu
201 15 system WITHOUT BEING ROOT except for the \texttt{bld\_prepare.sh}
202 and creating the desktop icon.
205 \subsection{Notable Options and Caveats}%
206 \label{sub:notable_options_and_caveats}
208 These procedures and the \CGG{} Infinity software have all been run
209 as \textbf{root} on various home laptops and desktops. This provides
210 the best chance to ensure all works correctly and also allows for
211 handling errors, other problems and potential crashes with the most
212 success. Included in this section are some of the build variations
213 easily available for normal builds.
215 To see the full list of features use:
217 \begin{lstlisting}[style=sh]
220 The default build is a system build which uses:
222 \begin{lstlisting}[style=sh]
223 ./configure --without-single-user
226 In the single-user build, the target directory is always
227 \texttt{cin}. Because this is also the developer build, constant
228 names are used throughout. However, you can rename files after the
231 If your operating system has issues with the default install to
232 \texttt{/usr/local}, you might have to change the location to
233 \texttt{/usr} for a system build. Then you will have to use:
234 \begin{lstlisting}[style=sh]
235 ./configure --prefix=/usr
238 If you wish to change the default directory for a system build you
239 will have to add the destination directory path on the \texttt{make
240 install} line. For example:
241 \begin{lstlisting}[style=sh]
242 make install DESTDIR=<your selected target directory path>
245 The application name can be set during installation, but defaults to
246 \texttt{cin} so that the GG/Infinity build can coexist with other
247 \CGG{} builds if necessary. To override the default \texttt{cin}
249 \begin{lstlisting}[style=sh]
250 ./configure --with-exec-name=cinelerra
253 The home configuration directory can also be set, but default
254 location is traditionally \texttt{\$HOME/.bcast5}. For example:
256 \begin{lstlisting}[style=sh]
257 ./configure -with-config-dir=/myusername/.bcast5
260 NOTE: when you specify parameters to the configure program, it will
261 create a \texttt{make} file as a consequence. Since in a
262 \texttt{make} file, the \$ is a special character, it must be
263 escaped so in order to represent a \$ as part of an input parameter,
264 it has to be stuttered. That is, you will need \$\$ (2 dollar
265 signs) to represent a single dollar sign.
267 It may be necessary on some distros which have missing or incomplete
268 up-to-date libraries, to build \CGG{} without Ladspa. To do so,
271 \begin{lstlisting}[style=sh]
272 ./configure --prefix=/usr --without-ladspa-build
275 Note that the with-ladspa-dir is the ladspa search path, and
276 exists even if the ladspa build is not selected. This gives you
277 the ability to specify an alternate ladspa system path by
278 utilizing the \texttt{LADSPA\_PATH} environment variable (that is,
279 the default ladspa build is deselected).
281 Note for 32-bit 14.2 Slackware, Debian, Gentoo, Arch, FreeBSD,
282 before running the configure, you will need to set up the following:
284 \begin{lstlisting}[style=sh]
285 export ac_cv_header_xmmintrin_h=no
286 export FFMPEG_EXTRA_CFG=" --disable-vdpau"
290 \subsection{Notes about Building from Git in your Customized Environment}%
291 \label{sub:notes_about_building_from_git_in_your_customized_environment}
293 Getting a build to work in a custom environment is not easy. If you
294 have already installed libraries which are normally in the
295 thirdparty build, getting them to be recognized means you have to
296 install the \textit{devel} version so the header files which match
297 the library interfaces exist. Below is the list of thirdparty
298 builds, but this list may have changed over time.
299 % It's list of Table?
303 \caption{List of thirdparty builds}
304 \label{tab:List_of_thirdparty_builds}
306 \begin{tabular}{m{8em}c}
350 The \textit{yes} means force build and \textit{auto} means probe and
351 use the system version if the build operation is not static. To get
352 your customized build to work, you need to change the probe options
353 for the conflicting libraries from \textit{yes} to \textit{auto}, or
354 even rework the \texttt{configure.ac} script. There may be several
355 libraries which need special treatment.
357 An example of a problem you might encounter with your customized
358 installation is with \texttt{a52dec} which has probes line
359 \texttt{(CHECK\_LIB/CHECK\_HEADERS)} in \texttt{configure.ac}, but
360 \texttt{djbfft} does not. In this case, \texttt{djbfft} is only
361 built because \texttt{a52dec} is built, so if your system has
362 \texttt{a52dec}, set \texttt{a52dec} to auto and see if that
363 problem is solved by retrying the build with:
364 \begin{lstlisting}[style=sh]
365 ./confgure --with-single-user -enable-a52dec=auto .
368 With persistence, you can get results, but it may take several tries
369 to stabilize the build. If you need help, email the \texttt{log}
370 and \texttt{config.log}, which is usually sufficient to determine
373 If you have already installed the \texttt{libfdk\_aac} development
374 package on your computer because you prefer this version over the
375 default aac, you will have to do the following to get this
376 alternative operational. The libfdk\_aac library is not a part of
377 \CGG{} by default because it is not license free.
379 \begin{lstlisting}[style=sh]
380 export FFMPEG_EXTRA_CFG=" --enable-libfdk-aac --enable-nonfree"
381 export EXTRA_LIBS=" -lfdk-aac"
382 for f in `grep -lw aac cinelerra-5.1/ffmpeg/audio/*`; do
383 sed -e 's/\<aac\>/libfdk_aac/' -i $f
388 \subsection{Cloning the Repository for Faster Updates}%
389 \label{sub:cloning_the_repository_for_faster_updates}
391 If you want to avoid downloading the software every time an update
392 is available you need to create a local ``repository'' or repo. The
393 repo is a directory where you first do a \texttt{git clone}. For
394 the initial git clone, set up a local area for the repository
395 storage, referred to as \texttt{<repo\_path>}. The \texttt{git
396 clone} creates a repo named \texttt{cin5} in the
397 \texttt{/<repo\_path>/} directory. This accesses about 530\,MB of
398 repo data, so the device has to have at least that available. The
399 repo path is always a perfect clone of the main repo.
402 \paragraph{Setting up the initial clone}%
403 \label{par:setting_up_the_initial_clone}
405 You may want to add ``\verb|--depth 1|'' before \texttt{cin5}
406 because this will clone faster and is smaller, but has no history.
408 \begin{lstlisting}[style=sh]
410 git clone "git://git.cinelerra-gg.org/goodguy/cinelerra" cin5
412 Cloning into "cin5"...
413 remote: Counting objects: 20032, done.
414 remote: Compressing objects: 100% (11647/11647), done.
415 remote: Total 20032 (delta 11333), reused 16632 (delta 8189)
416 Receiving objects: 100% (20032/20032), 395.29 MiB | 3.26 MiB/s, done.
417 Resolving deltas: 100% (11333/11333), done.
418 Checking connectivity... done.
422 \paragraph{Update an existing repo}%
423 \label{par:update_an_existing_repo}
424 The below shows how you can get updates.
426 \begin{lstlisting}[style=sh]
432 \paragraph{Useful git commands}%
433 \label{par:useful_git_commands}
434 Some other commands that are useful.
436 \begin{lstlisting}[style=sh]
437 git clone "git://git.cinelerra-gg.org/goodguy/cinelerra.git" cin5
438 git pull # pull remote changes to the local version
439 git status # shows changed files
440 git clean -i # interactive clean, use answer 1 to "clean"
444 \subsection{How to Build from a Previous GIT Version}%
445 \label{sub:how_to_build_from_a_previous_git_version}
447 If you have a problem with the current GIT version, you can revert
448 to a previous working version easily. The commands to use will be
449 similar to these next lines which are then explained in more detail.
452 \begin{lstlisting}[style=sh]
453 cd /<path>/cin5 # substitute your repo path name for cin5
454 git log # shows a list of versions
455 git checkout <version> # choose a version number as listed
458 The \texttt{git log} command produces a log file with hash values
459 for commit keys. The hash ids are the commit names to use when you
460 use git checkout. Next is displayed sample output:
462 \begin{lstlisting}[style=nil]
463 delete stray line in last checkin
465 commit 4a90ef3ae46465c0634f81916b79e279e4bd9961
466 Author: Good Guy <good1.2guy@gmail.com>
467 Date: Thu Feb 22 14:56:45 2018 -0700
469 nested clips, big rework and cleanup, sams new icons,
472 commit f87479bd556ea7db4afdd02297fc00977412b873
473 Author: Good Guy <good1.2guy@gmail.com>
474 Date: Sat Feb 17 18:09:22 2018 -0700
477 For the \texttt{git checkout <version>}, you would then keyin the
478 line below for the following results:
480 \begin{lstlisting}[style=nil]
481 git checkout f87479bd556ea7db4afdd02297fc00977412b873
483 Note: checking out 'f87479bd556ea7db4afdd02297fc00977412b873'.
485 You are in 'detached HEAD' state. You can look around, make
486 experimental changes and commit them, and you can discard any
487 commits you make in this state without impacting any branches by
488 performing another checkout.
490 If you want to create a new branch to retain commits you create,
491 you may do so (now or later) by using -b with the checkout command
494 git checkout -b <new-branch-name>
496 HEAD is now at f87479bd... more file size icon updates,
497 and more to followend
500 Later to get the repo back to current, use:
501 \begin{lstlisting}[style=sh]
506 \subsection{Debuggable Single User Build}%
507 \label{sub:debuggable_single_user_build}
509 To build from source with full debugging symbols, first build a full
510 static (non\_debug) build as follows but instead of using
511 \texttt{/tmp} substitute your permanent disk path if you want to
514 \begin{lstlisting}[style=sh]
516 git clone --depth 1 "git://git.cinelerra-gg.org/goodguy/cinelerra.git" cinelerra5
517 cp -a /<repo_path>/cinelerra-5.1 /tmp/
518 cd /tmp/cinelerra-5.1
522 Then, to run as a developer in the debugger:
524 \begin{lstlisting}[style=sh]
525 CFLAGS="-O2 -ggdb" make -j8 rebuild_all
531 \subsection{Unbundled Builds}%
532 \label{sub:unbundled_builds}
534 There are some generic build scripts included in the \CGG{} GIT
535 repository for users who want to do unbundled builds with ffmpeg
536 already available on their system. This has been tested on Arch,
537 Ubuntu 18, FreeBSD, Windows10 and Leap 15 (rpm) at the time this
540 The names of the build scripts are: \texttt{arch.bld},
541 \texttt{bsd.bld}, \texttt{deb.bld}, \texttt{rpm.bld}, and
542 \texttt{cygwin.bld}. These scripts are in the \texttt{blds}
543 subdirectory. The \texttt{bsd.bld} should be used with the
544 \texttt{bsd.patch} file in that same directory. The
545 \texttt{cygwin.bld} should be used with the \texttt{cygwin.patch}
546 file in that same directory.
548 The reason that Cin Infinity traditionally uses thirdparty builds
549 (bundled builds) is because there are a lot of different distros
550 with varying levels of ffmpeg and other needed thirdparty
551 libraries. However, some users prefer using their current system
552 baseline without another/different copy of ffmpeg.
554 With different levels of the userβs libraries, uncertainty,
555 potential instability, and unknown issues may come up while
556 running \CGG{} and this will make it, for all practical purposes,
557 impossible to diagnose and debug problems or crashes.
559 There may be no help in these cases. You are encouraged to report
560 any errors which potentially originate from Cin Infinity, but if
561 the data indicates alternate library sources, please report the
562 problems to the appropriate maintainers.
564 With the unbundled builds, some features may not be available and
565 no attempt to comment them out has been made. So if you use a
566 pulldown, or pick a render option, or choose something that is not
567 available, it just will not work. For example, unless special
568 options were set up by you, the LV2 audio plugins will not be
569 available. Nor will the codec libzmpeg, the file codec ac3, or
570 DVD creation. The old school file classes will all work, but some
571 of the formats that come with ffmpeg may not because of the way
572 that ffmpeg was installed on your operating system. That is
573 because the \CGG{} included ffmpeg is a known static build and is
574 usually the latest stable/released version. For example, in the
575 current case of Leap 15, libx264 and libx265 are not built in and
576 this can be debilitating; you can always run \texttt{ffmpeg
577 -formats} and \texttt{ffmpeg -codecs} to see what is available
581 \section{Download Already Built \CGG{}}%
582 \label{sec:download_already_built_cinelerra_gg}
586 \includegraphics[width=1.0\linewidth]{download-distros.png}
587 \caption{Screencast of the website Download page for installing \CGG{} for various O/S.}
588 \label{fig:download-distros}
591 If you prefer to not have to take the time to build \CGG{} Infinity
592 yourself, there are pre-built dynamic or static binaries for various
593 versions of Ubuntu, Mint, Suse, Fedora, Debian, Centos, Arch, and
594 Slackware linux as well as Gentoo and FreeBSD.
596 A Windows 10 version installation is described in~\ref{sec:ms_windows10}. There are also 32-bit i686 Ubuntu, Debian,
597 and Slackware versions available. These are updated on a fairly
598 regular basis as long as significant code changes have been made.
599 They are in subdirectories of:
602 \item \href{https://cinelerra-gg.org/download/tars}{https://cinelerra-gg.org/download/tars}
603 \item \href{https://cinelerra-gg.org/download/pkgs}{https://cinelerra-gg.org/download/pkgs}
606 The \textbf{tars} directory contains single-user static builds for
609 This is the recommended usage of \CGG{} because all of the files
610 will exist in a single directory. Generally all of the necessary
611 libraries are built into the static build, but in some cases you may
612 have to install another library that is being called for.
614 To install the single user builds, download the designated tarball
615 from the \texttt{./tars} subdirectory and unpack as indicated below:
617 \begin{lstlisting}[style=sh]
621 tar -xJf /src/path/cinelerra-5.1-*.txz # for the *,
623 # distro tarball name
626 \emph{Do not download the LEAP 10-bit version unless you use h265 (it
627 can't render 8-bit h265).}
629 The \textbf{pkgs} directory contains the standard packaged
630 application for various distros. This will install a dynamic
631 system version for users who prefer to have the binaries in the
632 system area and for multi-user systems.
634 In addition, performing the package install checks the md5sum in
635 the file \texttt{md5sum.txt} to ensure the channel correctly
636 transmits the package. There is a
637 \href{https://cinelerra-gg.org/download/README.pkgs}{README.pkgs}
638 file in the \texttt{download} directory with instructions so you
639 can \textit{cut and paste} and avoid typos; it is also shown
642 \lstset{inputpath=extra/}
645 basicstyle=\footnotesize,
646 caption={README.pkgs}
649 \section{Windows 10 with Cygwin for \CGG{} Limited}%
650 \label{sec:ms_windows10}
652 To run \CGG{} on a Windows 10 computer, you will need to have
653 Cygwin installed on your system, along with the \CGG{} static tar
654 and a patched library: libxbc. This setup has been tested with
655 Windows 10, version 1909, on an HP EliteBook 820 at 2.3 GHz.
657 This limited version provides \textit{core} functionality at this
658 time with the standard Windows FFmpeg executable, meaning that
659 specific modifications in FFmpeg needed for \CGG{} are not
660 available. Limited capabilities include only a few render output
661 formats available - for example \textit{mov}, \textit{qt} as
662 \textit{mjpeg}, and \textit{mpeg} for videos and \textit{avi} and
663 \textit{qt} as \textit{s16le} for audio, but not \textit{mkv} or
664 \textit{mp4}. This is due to the fact that several codec and
665 utility libraries are not currently compiled to work with Windows.
667 \subsection*{Installing Cygwin}
668 \label{sec:installing_cygwin}
670 Cygwin is an environment that runs natively on Windows which
671 allows Unix programs to be compiled and run on Windows. With
672 cygwin installed on your Windows 10 computer, you will be able to
673 run \CGG{}. Before installing cygwin, you need to be warned that
674 the Avast anti-virus software kills files necessary for cygwin
675 installation and execution, so you will have to remove it and use
676 alternative anti-virus software (the standard default already
677 included with Windows 10 is Defender). Below are the steps for
681 \item Download cygwin for your 64-bit computer at:
682 \href{https://www.cygwin.com/}{https://www.cygwin.com/}
684 \item Generally just take the defaults as they show up, but the
685 next steps show what comes up.
687 \item When a warning window pops up, click \textit{Yes}.
689 \item Click \textit{Next}.
691 \item Choose \textit{Install from Internet} option and then click
694 \item Choose your desired directory by clicking on Browse
695 button. Choose \textit{All Users (Recommended)} and then click
698 \item Choose the local package directory where you would like your
699 installation files to be placed. Click \textit{Next}.
701 \item Choose \textit{Direct Connection} if you are using Internet
702 with plug and play device. Click \textit{Next}.
704 \item Choose any download site preferably
705 ``cygwin.mirror.constant.com'' and then click \textit{Next}.
707 \item For list of things to install, leave all set to
708 \textit{Default} except these to \textit{Install} instead:
717 This install takes a long time; approximately 2 hours on an
718 EliteBook and requires approximately 20GB storage.
720 \item Finally you will want to have the icons on your desktop
721 (already default) and then click \textit{Finish}.
724 Then to install the \CGG{} tar files, you will need to start a
725 cygwin console terminal from the startup menu as shown here:
726 \texttt{Start $\rightarrow$ Cygwin $\rightarrow$ Cygwin64}
729 \subsection*{Installing \CGG{}}
730 \label{sec:installing_cinelerra}
733 \item Download the tar file
734 \href{https://cinelerra-gg.org/download/testing/libxcb-bld.tar.bz2}{libxcb-bld.tar.bz2}.
736 \item Install libxbc from the tar file -- installs into
737 \texttt{/usr/local} and requires approximately 21MB storage.
738 \begin{lstlisting}[style=sh]
739 tar -C /usr/local -xJf /path/libxcb-bld.tar.bz2
741 The libxcb path repairs an error (XIOError), which stops
744 \item Download the tar file
745 \href{https://cinelerra-gg.org/download/testing/cygcin-bld.tar.bz2}{cygcin-bld.tar.bz2}.
747 \item Install cygcin from the tar file - this installs into home
748 directory. Note this is cygcin \emph{not} cygwin. You must change the
749 \texttt{path} below to the name of the path where you downloaded
751 \begin{lstlisting}[style=sh]
753 tar -xJf /path/cygcin-bld.tar.bz2
757 This creates \texttt{\~{}/cygcin}, a user build installation of
758 \CGG{} and requires approximately 400MB storage.
760 \paragraph{Running \CGG{}:}
761 You will need to start a cygwin desktop from the startup menu:
763 \item \texttt{Start$\rightarrow$ Cygwin-X $\rightarrow$ Openbox}
765 You should start a console controlling terminal so that you can
768 \item \texttt{Start$\rightarrow$ Cygwin $\rightarrow$ Cygwin64} Terminal
770 This opens a separate window that can survive a cygwin hang and
771 bugs. Without these logs, it is much more difficult to use.
773 \item Type into that console controlling window, the following:
774 \begin{lstlisting}[style=sh]
778 \item Change directories to where \CGG{} is installed:
779 \begin{lstlisting}[style=sh]
780 cd /path/cygcin (NOT cygwin)
784 \begin{lstlisting}[style=sh]
787 which starts up your 4 \CGG{} windows.
790 The most noticeable difference from the Linux versions is that
791 \CGG{} seems to run very slowly on Windows 10. You must be very
792 tolerant and patient to see this work. It can however exhibit
793 astonishing speed when encoding. \CGG{} has to be downgraded
794 significantly due to lack of supported interfaces, codecs (for
795 example h264/h265), and utilities. The only graphics driver is
796 X11 and the only sound driver is pulseaudio. Almost all
797 configurable omissions are applied to this build.
799 \paragraph{\CGG{} build on cygwin from source code:}
802 \item Download and install ffmpeg into /usr/local :
804 download ffmpeg (currently 4.2.2)
805 \begin{lstlisting}[style=sh]
807 tar -xJf /path/ffmpeg-4.2.2.tar.bz2
814 \item Download and install a patched libxcb:
815 \begin{lstlisting}[style=sh]
818 tar -xf /path/libxcb-1.13.tar.bz2
820 patch -p1 < /path/cinelerra-5.1/thirdparty/src/libxcb.patch1
821 patching file configure.ac
822 patching file src/xcb_in.c
828 \item Download cinelerra-gg:
829 \begin{lstlisting}[style=sh]
831 git clone "git://git.cinelerra-gg.org/goodguy/cinelerra.git"
832 cd cinelerra-gg/cinelerra-5.1
834 \item Apply cygwin patch:
835 \begin{lstlisting}[style=sh]
836 patch -p2 < blds/cygwin.patch
838 \item Run the build with:
839 \begin{lstlisting}[style=sh]
844 This produces a directory: /build\_path/cinelerra-gg/cinelerra-5.1/bin
845 which is used to create the cygcin archive.
847 Currently, the targets are not stripped and can be run from gdb.
848 There is only very limited signal handler dmp file support.
849 Running gdb from inside a desktop resident console (not a cygwin64
850 window) will hang cygwin (and cin) when it hits a breakpoint. You
851 must run from an external console window to avoid this issue.
854 \section{Distribution Systems with \CGG{} Included}%
855 \label{sec:distribution_systems_with_cinelerra_included}
857 There are also some special complete distribution systems
858 available that include \CGG{} for audio and video production
861 \subsection{AV Linux}
864 \textbf{AV Linux} is a downloadable/installable shared snapshot
865 ISO image based on Debian. It provides the user an easy method to
866 get an Audio and Video production workstation without the hassle
867 of trying to find and install all of the usual components
868 themselves. Of course, it includes \CGG{}!
871 \href{http://www.bandshed.net/avlinux/}{homepage of AV Linux}.
873 \subsection{Bodhi Linux Media}
874 \label{sec:Bodhi_Linux}
876 \textbf{Bodhi Linux Media} is a free and open source distribution that
877 comes with a curated list of open source software for digital
878 artists who work with audio, video, includes \CGG{}, games,
879 graphics, animations, physical computing, etc.
882 \href{https://gitlab.com/giuseppetorre/bodhilinuxmedia}{homepage of Bodhi Linux}.
887 \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.
\r
889 Click \href{https://www.elivecd.org/}{Elive} for more information.
891 \section{Cinx and a βBitβ of Confusion}%
892 \label{sec:cinx_and_a_bit_of_confusion}
894 Cinx is the exact same program as Cin. The X (x) represents the
895 roman numeral 10 for 10-bit as opposed to 8-bit standard. The
896 third-party library used for x265 must be specially compiled with
897 \texttt{--bit-depth=10} in order to produce 10-bit rendered
900 This build will not be able to output 8-bit depth which means you
901 have to retain the Cin version also.
903 Whatever build ffmpeg is linked to will determine what bit depth
904 it can output. This is why there have to be separate builds. If
905 you install both packages, Cin and CinX, you may get \textit{file
906 conflicts of same file name} --- just continue.
908 Keep in mind that the regular 8-bit version works on 8-bit bytes
909 --- the standard word size for computers, but the 10-bit version
910 has to use 2 words to contain all 10 bits so you can expect
911 rendering to be as much as twice as slow.
913 There is also a 12-bit version for consideration but currently the
914 results are simply the same as 10-bit with padding to make 12-bit
915 so it is of no value.
920 %%% TeX-master: "../CinelerraGG_Manual"