2 \label{cha:Installation}
5 \section{\CGG{} AppImage}%
6 \label{sec:cin_gg_appimage}
8 The main way to install \CGG{} is to use the AppImage. This is updated regularly and works for every distro, since it already contains the necessary dependencies.
9 A big advantage of using the AppImage format is that it is only 1/3 the size of the normal install,
10 and since each release is named differently, you can keep a number of versions in a directory,
11 and when testing from a terminal you just have to type CinGG, then hit tab, and complete it to
12 the desired date release.
14 For 64-bit systems you can choose between an image with up-to-date libraries or one that supports older libraries, which you should use only if the first image gives you problems with unsupported libs. There is also a 32-bit older distro available that has \textit{i686} as part of the filename and a 8/10/12 bit newer distro that handles 8 or 10 or 12 bits that has \textit{multibit} as part of the filename. Installing the appimage is simple:
16 Download the file from:
18 \url{https://cinelerra-gg.org/download/images/}
20 Some example file names are as follows - where 8 digits represent yyyymmdd:
22 \begin{lstlisting}[style=sh]
23 CinGG-20210731-x86_64.AppImage
24 (currently based on Fedora Core 32, libc version 2.31)
25 CinGG-20210731-x86_64-older-distros.AppImage
26 (currently based on Ubuntu 16.04, libc version 2.23)
27 CinGG-20210731-i686.AppImage
28 (currently based on Debian 9, linux kernel 4.9)
29 CinGG-20210731-x86_64-multibit.AppImage
30 (currently based on Fedora Core 32, libc version 2.31)
33 Make the file executable with the proper execute permissions either from the GUI of the Desktop Environment used (link to the file) or from a terminal window. Make sure you are already in the directory containing the appimage:
35 \begin{lstlisting}[style=sh]
36 $ chmod u+x CinGG-yyyymmdd.AppImage
39 Finally start the program from a window in the directory where the image is stored:
41 \begin{lstlisting}[style=sh]
42 $ ./CinGG-yyyymmdd.AppImpage
45 or create a convenient desktop icon with a link to the run action, or do a \textit{Desktop Integration} manually or with external programs. There is a
46 description of a GUI methodology for doing so in this file on the webiste:
48 \url{https://cinelerra-gg.org/download/images/README\_appimage.txt}
50 Most distros already have the libraries to run the appimage, but if not you may need an additional installation. For example Arch Linux needs the \texttt{libappimage} package.
52 \begin{lstlisting}[style=sh]
53 sudo pacman -S libappimage
56 And Leap 15.3 (OpenSUSE) requires installation of the \textit{appimage} package.
58 \begin{lstlisting}[style=sh]
59 sudo zypper se -is appimage
62 In addition, if you are using the OpenGL video driver, you will need to install the appropriate OpenGL
63 drivers for your Operating System graphics board because libGLU.so and other OpenGL libraries are
64 not included in the AppImage.
66 \section{Download Already Built \CGG{}}%
67 \label{sec:download_already_built_cinelerra_gg}
71 \includegraphics[width=1.0\linewidth]{download-distros.png}
72 \caption{Screencast of the website Download page for installing \CGG{} for various O/S.}
73 \label{fig:download-distros}
76 If you prefer to not have to take the time to build \CGG{} Infinity
77 yourself, there are pre-built dynamic or static binaries for various
78 versions of Ubuntu, Mint, Suse, Fedora, Debian, Centos, Arch, and
79 Slackware linux as well as Gentoo and FreeBSD. If you do want to build it yourself so that
80 you get the added benefit of the latest checked in changes, please reference
81 ~\ref{sec:How_to_build}.
83 A Windows 10 version installation is described in~\ref{sec:ms_windows10}. There are also 32-bit i686 Ubuntu, Debian,
84 and Slackware versions available. \textbf{These binaries are no longer being updated; they are stable and working but without future functionality}.
85 They are in subdirectories of:
88 \item \href{https://cinelerra-gg.org/download/tars}{https://cinelerra-gg.org/download/tars}
89 \item \href{https://cinelerra-gg.org/download/pkgs}{https://cinelerra-gg.org/download/pkgs}
92 The \textbf{tars} \index{tars} directory contains single-user static builds for
95 This is the recommended usage of \CGG{} because all of the files
96 will exist in a single directory. Generally all of the necessary
97 libraries are built into the static build, but in some cases you may
98 have to install another library that is being called for.
100 To install the single user builds, download the designated tarball
101 from the \texttt{./tars} subdirectory and unpack as indicated below:
103 \begin{lstlisting}[style=sh]
107 tar -xJf /src/path/cinelerra-5.1-*.txz # for the *, substitute your distro tarball name
110 \emph{Do not download the LEAP 10-bit version unless you specifically want to
111 use h265 rendering to 10-bit instead of the more standard 8-bit.} For more
112 information see ~\ref{sec:cinx_and_a_bit_of_confusion}.
114 The \textbf{pkgs} \index{pkgs} directory contains the standard packaged
115 application for various distros. This will install a dynamic
116 system version for users who prefer to have the binaries in the
117 system area and for multi-user systems.
119 In addition, performing the package install checks the md5sum in
120 the file \texttt{md5sum.txt} to ensure the channel correctly
121 transmits the package. There is a
122 \href{https://cinelerra-gg.org/download/README.pkgs}{README.pkgs}
123 file in the \texttt{download} directory with instructions so you
124 can \textit{cut and paste} and avoid typos; it is also shown
127 \lstset{inputpath=extra/}
130 basicstyle=\footnotesize,
131 caption={README.pkgs}
134 \section{How to Build \CGG{} from Developer's Git Repository}%
135 \label{sec:How_to_build}
139 These are generic build instructions for building \CGG{} Infinity.
140 Known to work on Ubuntu, Mint, OpenSuse, Fedora, Debian, Centos,
141 Arch, Slackware, and Gentoo. It has not been tested on every
142 single possible distro yet so you might expect to have to make
143 some minor changes. Also works on a somewhat limited basis on
144 FreeBSD and Windows 10 with the bsd.patch for FreeBSD and the
145 cygwin.patch for Windows 10.
147 NOTE: as of May 31, 2021 when Context Help was added, to include
148 this Context Help you will need to download the corresponding
149 tgz file containing the HTML manual sections referenced for the
150 Help pages. The file to download is:
151 \url{https://cinelerra-gg.org/download/images/HTML_Manual-20210531.tgz}
152 substituting for "20210531" the "yyyymmdd" representing latest release date.
153 Then unpack to your Cinelerra/bin/doc directory so it is included in
157 Alternatively, there are some pre-built dynamic or static binaries
158 which are updated on a fairly regular basis (as long as code changes
159 have been made) available at the link below.
161 \href{https://cinelerra-gg.org/download/}{https://cinelerra-gg.org/download/}
164 There are 2 kinds of builds, the default system-build and a
165 single-user build. A system build has results which are installed
166 to the system. The majority of the files are installed in the
167 standard system paths, but some customization is possible. The
168 single user build allows for running completely out of a local
169 user directory so it doesn't affect the system.
171 We recommend the single-user version when possible. It makes it
172 very easy to install a new version without having to delete the
173 older version in case you want it for backup -- once you are happy
174 with the new version, all you have to do is delete the entire old
175 directory path. Another reason for using single-user is that if
176 you install a new Operating System version and if you have \CGG{}
177 on separate disk space that is preserved, you won't have to
178 reinstall \CGG{}. It is also convenient for the purpose of having
179 the ability to interrupt or to see any possible error messages, if
180 you start the application from a terminal window command line
181 where you will have more control to catch problems. All that
182 said, the system builds can be useful in a university lab setting
183 where there are possibly multiple users, or multiple versions.
185 There are two notable differences between standard views
186 of \CGG{} and this implementation for the system builds. Both of
187 these can be configured during installation. The differences make
188 it possible to have several different versions installed without
189 having them interfere with each other.
192 \item application name can be set during a build but defaults
194 \item the home configuration directory can also be set and
195 traditionally defaults to: \texttt{\$HOME/.bcast5}
199 \subsection{The system build}
200 \label{sec:system-build}
203 To do a system build \index{build} , you should read the file
204 \texttt{README} that is at the top level after you get the source.
207 \item You need about 6.0 \,GB of disk storage to operate a build and
208 you need to have \textit{git} installed.
210 \item Obviously in order to install into the system, you must run as
213 \item The \textit{git:} step has to download many files (approx
214 130\,MB) so allow time. When decompressed this will expand to
217 \item Run the following commands (this takes awhile):
219 \begin{lstlisting}[style=sh]
220 # This is where you need the 6.0GB of disk space:
222 git clone --depth 1 "git://git.cinelerra-gg.org/goodguy/cinelerra.git" cinelerra5
223 # Change to the cloned directory:
224 cd cinelerra5/cinelerra-5.1
226 NOTE: if your system has never had \CGG{} Infinity installed, you
227 will have to make sure you have all of the compilers and libraries
228 necessary. So on the very first build you should run:
230 \begin{lstlisting}[style=sh]
231 ./blds/bld_prepare.sh <os> # where <os> represents the
232 # Operating System of
233 # centos, fedora, suse, ubuntu, mint, debian.
235 ./configure --prefix=/usr # optional parameters can be added here
236 make 2>&1 | tee log # make and log the build
239 \texttt{bld\_prepare.sh} does not work for Arch Linux or Gentoo,
240 so we have to install the dependencies
241 manually. \texttt{README.arch} or \texttt{README.gentoo}, which
242 contain the list of dependencies, can be found at:
244 \item \href{https://cinelerra-gg.org/download/README.arch}{https://cinelerra-gg.org/download/README.arch}
245 \item \href{https://cinelerra-gg.org/download/README.gentoo}{https://cinelerra-gg.org/download/README.gentoo}
248 \item Check for obvious build errors:
249 \begin{lstlisting}[style=sh]
250 grep "\*\*\*.*error" -ai log
252 If this reports errors and you need assistance or you think
253 improvements can be made to the builds, email the log which is
255 \href{mailto:cin@lists.cinelerra-gg.org}{cin@lists.cinelerra-gg.org}
256 \begin{lstlisting}[style=sh]
257 /<build_path>/cinelerra5/cinelerra-5.1/log
260 \item If there are no build errors, finally just run:
261 \begin{lstlisting}[style=sh]
264 Where <os> represents the Operating System supported by \CGG{}, such
265 as centos, fedora, suse, ubuntu, mint, debian.
266 The ``with-single-user'' parameter makes it so.
267 % Make and log build (
268 Check for errors before proceeding.
271 \item If it all worked, you are all setup. Just click on the \CGG{}
276 \subsection{The single-user build}
277 \label{sec:single-user-build}
278 \index{single-user build}
281 To do a single-user build, read the file \texttt{README} that is at
282 the top level after you get the source.
285 \item You need at least 6\,GB of disk storage to operate a build +
286 you need to have “\texttt{git}” installed.
288 \item Recommend you build and run as \textbf{root}, just to avoid
289 permission issues initially.
290 \item The \textit{git} step has to download many files (approx
291 130\,MB) so allow time.
293 \item Run the following commands (this takes awhile):
294 \begin{lstlisting}[style=sh]
295 # This is where you need the 6GB of disk space
297 git clone --depth 1 "git://git.cinelerra-gg.org/goodguy/cinelerra.git" cinelerra5
298 # Toplevel directory:
299 cd cinelerra5/cinelerra-5.1
303 NOTE: if your system has never had \CGG{} Infinity installed, you
304 will have to make sure all the compilers and libraries necessary are
305 installed. So on the very first build you should run as
308 % FIXME No novels in the listings.
309 \begin{lstlisting}[style=sh]
310 ./blds/bld_prepare.sh <os>
312 ./configure --with-single-user
316 Where <os> represents the Operating System supported by \CGG{}, such
317 as centos, fedora, suse, ubuntu, mint, debian.
318 The ``with-single-user'' parameter makes it so.
319 % Make and log build (
320 Check for errors before proceeding.
323 Then just start the application by keying in: \texttt{./cin} in the
324 bin subdirectory OR add a desktop icon by using the appropriate
325 directory to copy the files to, run as \textbf{root}, and edit to
326 correct the directory path. Below are generic directions of how to
329 Then just start the application by keying in: \texttt{./cin} in the
330 bin subdirectory OR add a desktop icon by using the appropriate
331 directory to copy the files to, run as \textbf{root}, and edit to
332 correct the directory path. Below are generic directions of how to
335 \begin{lstlisting}[style=sh]
336 cd /cinelerra_directory_path
337 cp -a image/cin.{svg,xpm} /usr/share/pixmaps/
338 cp -a image/cin.desktop /usr/share/applications/cin.desktop
341 After you have followed the above, in the cin.desktop file, change
342 the \texttt{Exec=cin} line to be
343 \texttt{Exec=<your\_directory\_path>/bin/cin}.
345 The preceding directions for doing a single-user build may work
346 without being root on some distros except for the \texttt{bld\_prepare.sh}
347 and creating the desktop icon. For example in Arch Linux installing without being root
348 works using the following steps:
350 \begin{lstlisting}[style=sh]
351 $ git clone --depth 1 "git://git.cinelerra-gg.org/goodguy/cinelerra.git" cinelerra5
352 $ cd /home/USER/cinelerra5/cinelerra-5.1
354 $ ./configure --prefix=/usr --with-single-user --with-booby
355 $ make 2>&1 | tee /tmp/cin5.log && make install
359 \subsection{Notable Options and Caveats}%
360 \label{sub:notable_options_and_caveats}
363 These procedures and the \CGG{} Infinity software have all been run
364 as \textbf{root} on various home laptops and desktops. This provides
365 the best chance to ensure all works correctly and also allows for
366 handling errors, other problems and potential crashes with the most
367 success. Included in this section are some of the build variations
368 easily available for normal builds.
370 To see the full list of features use:
372 \begin{lstlisting}[style=sh]
375 The default build \index{build} is a system build which uses:
377 \begin{lstlisting}[style=sh]
378 ./configure --without-single-user
381 In the single-user build \index{single-user build}, the target directory is always
382 \texttt{cin}. Because this is also the developer build, constant
383 names are used throughout. However, you can rename files after the
386 If your operating system has issues with the default install to
387 \texttt{/usr/local}, you might have to change the location to
388 \texttt{/usr} for a system build. Then you will have to use:
389 \begin{lstlisting}[style=sh]
390 ./configure --prefix=/usr
393 If you wish to change the default directory for a system build you
394 will have to add the destination directory path on the \texttt{make
395 install} line. For example:
396 \begin{lstlisting}[style=sh]
397 make install DESTDIR=<your selected target directory path>
400 The application name can be set during installation, but defaults to
401 \texttt{cin} so that the GG/Infinity build can coexist with other
402 \CGG{} builds if necessary. To override the default \texttt{cin}
404 \begin{lstlisting}[style=sh]
405 ./configure --with-exec-name=cinelerra
408 The home configuration directory can also be set, but default
409 location is traditionally \texttt{\$HOME/.bcast5}. For example:
411 \begin{lstlisting}[style=sh]
412 ./configure -with-config-dir=/myusername/.bcast5
415 NOTE: when you specify parameters to the configure program, it will
416 create a \texttt{make} file as a consequence. Since in a
417 \texttt{make} file, the \$ is a special character, it must be
418 escaped so in order to represent a \$ as part of an input parameter,
419 it has to be stuttered. That is, you will need \$\$ (2 dollar
420 signs) to represent a single dollar sign.
422 It may be necessary on some distros which have missing or incomplete
423 up-to-date libraries, to build \CGG{} without Ladspa. To do so,
426 \begin{lstlisting}[style=sh]
427 ./configure --prefix=/usr --without-ladspa-build
430 Note that the with-ladspa-dir is the ladspa search path, and
431 exists even if the ladspa build is not selected. This gives you
432 the ability to specify an alternate ladspa system path by
433 utilizing the \texttt{LADSPA\_PATH} environment variable (that is,
434 the default ladspa build is deselected).
436 Note for 32-bit 14.2 Slackware, Debian, Gentoo, Arch, FreeBSD,
437 before running the configure, you will need to set up the following:
439 \begin{lstlisting}[style=sh]
440 export ac_cv_header_xmmintrin_h=no
441 export FFMPEG_EXTRA_CFG=" --disable-vdpau"
444 NOTE: as of May 31, 2021 when Context Help was added, to include
445 this Context Help you will need to download the corresponding
446 tgz file containing the HTML manual sections referenced for the
447 Help pages. The file to download is:
448 \url{https://cinelerra-gg.org/download/images/HTML_Manual-20210531.tgz}
449 substituting for "20210531" the "yyyymmdd" representing latest release date.
450 Then unpack to your Cinelerra/bin/doc directory so it is included in
451 your built system. The reason for not including the HTML manual in
452 the source code so that it would already be there, is because it is
453 very large and has its own GIT base.
455 \subsection{Notes about Building from Git in your Customized Environment}%
456 \label{sub:notes_about_building_from_git_in_your_customized_environment}
461 Getting a build to work in a custom environment is not easy. If you
462 have already installed libraries which are normally in the
463 thirdparty build, getting them to be recognized means you have to
464 install the \textit{devel} version so the header files which match
465 the library interfaces exist. Below is the list of thirdparty
466 builds, but this list may have changed over time.
467 % It's list of Table?
471 \begin{longtable}{m{8em} c}
472 \caption{List of thirdparty builds}
473 \label{tab:List_of_thirdparty_builds}\\
516 The \textit{yes} means force build and \textit{auto} means probe and
517 use the system version if the build operation is not static. To get
518 your customized build to work, you need to change the probe options
519 for the conflicting libraries from \textit{yes} to \textit{auto}, or
520 even rework the \texttt{configure.ac} script. There may be several
521 libraries which need special treatment.
523 An example of a problem you might encounter with your customized
524 installation is with \texttt{a52dec} which has probes line
525 \texttt{(CHECK\_LIB/CHECK\_HEADERS)} in \texttt{configure.ac}, but
526 \texttt{djbfft} does not. In this case, \texttt{djbfft} is only
527 built because \texttt{a52dec} is built, so if your system has
528 \texttt{a52dec}, set \texttt{a52dec} to auto and see if that
529 problem is solved by retrying the build with:
530 \begin{lstlisting}[style=sh]
531 ./confgure --with-single-user -enable-a52dec=auto .
534 With persistence, you can get results, but it may take several tries
535 to stabilize the build. If you need help, email the \texttt{log}
536 and \texttt{config.log}, which is usually sufficient to determine
539 If you have already installed the \texttt{libfdk\_aac} development
540 package on your computer because you prefer this version over the
541 default aac, you will have to do the following to get this
542 alternative operational. The libfdk\_aac library is not a part of
543 \CGG{} by default because it is not license free.
545 \begin{lstlisting}[style=sh]
546 export FFMPEG_EXTRA_CFG=" --enable-libfdk-aac --enable-nonfree"
547 export EXTRA_LIBS=" -lfdk-aac"
548 for f in `grep -lw aac cinelerra-5.1/ffmpeg/audio/*`; do
549 sed -e 's/\<aac\>/libfdk_aac/' -i $f
554 \subsection{Cloning the Repository for Faster Updates}%
555 \label{sub:cloning_the_repository_for_faster_updates}
559 If you want to avoid downloading the software every time an update
560 is available you need to create a local ``repository'' or repo. The
561 repo is a directory where you first do a \texttt{git clone}. For
562 the initial git clone, set up a local area for the repository
563 storage, referred to as \texttt{<repo\_path>}. The \texttt{git
564 clone} creates a repo named \texttt{cin5} in the
565 \texttt{/<repo\_path>/} directory. This accesses about 530\,MB of
566 repo data, so the device has to have at least that available. The
567 repo path is always a perfect clone of the main repo.
570 \paragraph{Setting up the initial clone}%
571 \label{par:setting_up_the_initial_clone}
573 You may want to add ``\verb|--depth 1|'' before \texttt{cin5}
574 because this will clone faster and is smaller, but has no history.
576 \begin{lstlisting}[style=sh]
578 git clone "git://git.cinelerra-gg.org/goodguy/cinelerra" cin5
580 Cloning into "cin5"...
581 remote: Counting objects: 20032, done.
582 remote: Compressing objects: 100% (11647/11647), done.
583 remote: Total 20032 (delta 11333), reused 16632 (delta 8189)
584 Receiving objects: 100% (20032/20032), 395.29 MiB | 3.26 MiB/s, done.
585 Resolving deltas: 100% (11333/11333), done.
586 Checking connectivity... done.
590 \paragraph{Update an existing repo}%
591 \label{par:update_an_existing_repo}
592 The below shows how you can get updates.
594 \begin{lstlisting}[style=sh]
600 \paragraph{Useful git commands}%
601 \label{par:useful_git_commands}
602 Some other commands that are useful.
604 \begin{lstlisting}[style=sh]
605 git clone "git://git.cinelerra-gg.org/goodguy/cinelerra.git" cin5
606 git pull # pull remote changes to the local version
607 git status # shows changed files
608 git clean -i # interactive clean, use answer 1 to "clean"
612 \subsection{How to Build from a Previous GIT Version}%
613 \label{sub:how_to_build_from_a_previous_git_version}
618 If you have a problem with the current GIT version, you can revert
619 to a previous working version easily. The commands to use will be
620 similar to these next lines which are then explained in more detail.
623 \begin{lstlisting}[style=sh]
624 cd /<path>/cin5 # substitute your repo path name for cin5
625 git log # shows a list of versions depending on history depth specification
626 git checkout <version> # choose a version number as listed
629 The \texttt{git log} command produces a log file with hash values
630 for commit keys to the level specifed if the the depth paramter
632 The hash ids are the commit names to use when you
633 use git checkout. Next is displayed sample output:
635 \begin{lstlisting}[style=nil]
636 delete stray line in last checkin
638 commit 4a90ef3ae46465c0634f81916b79e279e4bd9961
639 Author: Good Guy <good1.2guy@gmail.com>
640 Date: Thu Feb 22 14:56:45 2018 -0700
642 nested clips, big rework and cleanup, sams new icons,
645 commit f87479bd556ea7db4afdd02297fc00977412b873
646 Author: Good Guy <good1.2guy@gmail.com>
647 Date: Sat Feb 17 18:09:22 2018 -0700
650 For the \texttt{git checkout <version>}, you would then keyin the
651 line below for the following results:
653 \begin{lstlisting}[style=nil]
654 git checkout f87479bd556ea7db4afdd02297fc00977412b873
656 Note: checking out 'f87479bd556ea7db4afdd02297fc00977412b873'.
658 You are in 'detached HEAD' state. You can look around, make
659 experimental changes and commit them, and you can discard any
660 commits you make in this state without impacting any branches by
661 performing another checkout.
663 If you want to create a new branch to retain commits you create,
664 you may do so (now or later) by using -b with the checkout command
667 git checkout -b <new-branch-name>
669 HEAD is now at f87479bd... more file size icon updates,
670 and more to followend
673 Later to get the repo back to current, use:
674 \begin{lstlisting}[style=sh]
679 \subsection{Debuggable Single User Build}%
680 \label{sub:debuggable_single_user_build}
681 \index{single-user build}
684 To build from source with full debugging symbols, first build a full
685 static (non\_debug) build as follows but instead of using
686 \texttt{/tmp} substitute your permanent disk path if you want to
689 \begin{lstlisting}[style=sh]
691 git clone --depth 1 "git://git.cinelerra-gg.org/goodguy/cinelerra.git" cinelerra5
692 cp -a /<repo_path>/cinelerra-5.1 /tmp/
693 cd /tmp/cinelerra-5.1
697 Then, to run as a developer in the debugger:
699 \begin{lstlisting}[style=sh]
700 CFLAGS="-O2 -ggdb" make -j8 rebuild_all
706 \subsection{Unbundled Builds}%
707 \label{sub:unbundled_builds}
712 There are some generic build scripts included in the \CGG{} GIT
713 repository for users who want to do unbundled builds with ffmpeg
714 already available on their system. This has been tested on Arch,
715 Ubuntu 18, FreeBSD, Windows10 and Leap 15 (rpm) at the time this
718 The names of the build scripts are: \texttt{arch.bld},
719 \texttt{bsd.bld}, \texttt{deb.bld}, \texttt{rpm.bld}, and
720 \texttt{cygwin.bld}. These scripts are in the \texttt{blds}
721 subdirectory. The \texttt{bsd.bld} should be used with the
722 \texttt{bsd.patch} file in that same directory. The
723 \texttt{cygwin.bld} should be used with the \texttt{cygwin.patch}
724 file in that same directory.
726 The reason that Cin Infinity traditionally uses its own thirdparty builds
727 (bundled builds) is because there are a lot of different distros
728 with varying levels of ffmpeg and other needed thirdparty
729 libraries. However, some users prefer using their current system
730 baseline without another/different copy of ffmpeg.
732 With different levels of the user’s libraries, uncertainty,
733 potential instability, and unknown issues may come up while
734 running \CGG{} and this will make it, for all practical purposes,
735 impossible to diagnose and debug problems or crashes.
737 There may be no help in these cases. You are encouraged to report
738 any errors which potentially originate from Cin Infinity, but if
739 the data indicates alternate library sources, please report the
740 problems to the appropriate maintainers.
742 With the unbundled builds, some features may not be available and
743 no attempt to comment them out has been made. So if you use a
744 pulldown, or pick a render option, or choose something that is not
745 available, it just will not work. For example, unless special
746 options were set up by you, the LV2 audio plugins will not be
747 available. Nor will the codec libzmpeg, the file codec ac3, or
748 DVD creation. The old school file classes will all work, but some
749 of the formats that come with ffmpeg may not because of the way
750 that ffmpeg was installed on your operating system. That is
751 because the \CGG{} included ffmpeg is a known static build and is
752 usually the latest stable/released version. For example, in the
753 current case of Leap 15, libx264 and libx265 are not built in and
754 this can be debilitating; you can always run \texttt{ffmpeg
755 -formats} and \texttt{ffmpeg -codecs} to see what is available
758 \section{Building the HTML Manual for Context Help}%
759 \label{sec:building_the_manual}
762 In addition to compiling your own \CGG{}, you should also build an html version of the manual that is needed for Context Help in the program. The main version of the manual is in latex to produce a pdf version of the manual and this is required to be built first as the basis for the html version. This means that you need a full latex environment, git, and the latex2html program in order to eventually create the html version. Texlive is about 1 GB; Latex2html itself has many requirements and missing any will result in failure: some requirments include Netpbm, GhostScript, dvips, etc. Latex2html must be at least version \textit{2021.2} in order to create the html manual version from the latex.
764 The steps are as follows:
766 \item Download the manual in LaTeX:
768 \begin{lstlisting}[style=sh]
769 git clone "git://git.cinelerra-gg.org/goodguy/cin-manual-latex.git" master
772 \item Included in the download is the \texttt{translate\_manual} script. After modifying this file to have execute permission, run this script from a terminal window in the \textit{master} directory where it was downloaded (be aware that this script includes several \textit{rm} commands):
773 \begin{lstlisting}[style=sh]
777 The steps that this script performs are as follows:
779 \item PDF production. The PDF document will be produced from the latex source in the \textit{master} directory. Since the glossary and index are also present, it has to run the pdf build several times. The following commands in the \texttt{translate\_manual} script produce the PDF document from latex source which includes invoking makeindex for the Index and Glossary.
781 \begin{lstlisting}[style=sh]
782 pdflatex CinelerraGG_Manual.tex
783 makeindex CinelerraGG_Manual.idx
784 pdflatex CinelerraGG_Manual.tex
785 makeindex CinelerraGG_Manual.nlo -s nomencl.ist -o CinelerraGG_Manual.nls
786 pdflatex CinelerraGG_Manual.tex
789 After these commands are executed you will have the manual only in PDF format. So if you only want a PDF version, you only need to run these previous 5 lines but Context Help from the program will not be available with the PDF version.
790 \item Next, to produce HTML output the script then moves (renames) \texttt{latex 2html-init} to \texttt{.latex2html-init} (starting with dot).
792 \item Then the script uses latex2html: latex2html is run with a unique set of parameters and some cleanup is performed. It creates the directory CinelerraGG\_Manual containing all the files of the manual in html: tables, references, index, glossary, and various images.
795 \item After installation of the \CGG{} program, place the complete unchanged directory \texttt{CinelerraGG\_Manual}, as it was produced by latex2html from the manual package, into the \textit{doc} directory of the installed Cinelerra package. This will be the directory \textit{bin/doc/CinelerraGG\_Manual} if \CGG{} was built \texttt{--with-single-user}. The script ContextManual.pl will automatically be in bin/doc after the successful build of the program. It is this perl script that allows the program to access CinelerraGG\_Manual to offer Context Help.
797 \item Optionally you can make some adjustments to the latex2html command line in the \texttt{translate\_manual} script. Some variants are shown in the comments inside the script but changes may impact the usability of Alt/h hotkey from the program.
800 \section{Windows 10 with Cygwin for \CGG{} Limited}%
801 \label{sec:ms_windows10}
804 To run \CGG{} on a Windows 10 computer, you will need to have
805 Cygwin installed on your system, along with the \CGG{} static tar
806 and a patched library: libxcb. This setup has been tested with
807 Windows 10, version 1909, on an HP EliteBook 820 at 2.3 GHz.
809 This limited version provides \textit{core} functionality at this
810 time with the standard Windows FFmpeg executable, meaning that
811 specific modifications in FFmpeg needed for \CGG{} are not
812 available. Limited capabilities include only a few render output
813 formats available - for example \textit{mov}, \textit{qt} as
814 \textit{mjpeg}, and \textit{mpeg} for videos and \textit{avi} and
815 \textit{qt} as \textit{s16le} for audio, but not \textit{mkv} or
816 \textit{mp4}. This is due to the fact that several codec and
817 utility libraries are not currently compiled to work with Windows.
819 \subsection*{Installing Cygwin}
820 \label{sec:installing_cygwin}
823 Cygwin is an environment that runs natively on Windows which
824 allows Unix programs to be compiled and run on Windows. With
825 cygwin installed on your Windows 10 computer, you will be able to
826 run \CGG{}. Before installing cygwin, you need to be warned that
827 the Avast anti-virus software kills files necessary for cygwin
828 installation and execution, so you will have to remove it and use
829 alternative anti-virus software (the standard default already
830 included with Windows 10 is Defender). Below are the steps for
834 \item Download cygwin for your 64-bit computer at:
835 \href{https://www.cygwin.com/}{https://www.cygwin.com/}
837 \item Generally just take the defaults as they show up, but the
838 next steps show what comes up.
840 \item When a warning window pops up, click \textit{Yes}.
842 \item Click \textit{Next}.
844 \item Choose \textit{Install from Internet} option and then click
847 \item Choose your desired directory by clicking on Browse
848 button. Choose \textit{All Users (Recommended)} and then click
851 \item Choose the local package directory where you would like your
852 installation files to be placed. Click \textit{Next}.
854 \item Choose \textit{Direct Connection} if you are using Internet
855 with plug and play device. Click \textit{Next}.
857 \item Choose any download site preferably
858 ``cygwin.mirror.constant.com'' and then click \textit{Next}.
860 \item For list of things to install, leave all set to
861 \textit{Default} except these to \textit{Install} instead:
870 This install takes a long time; approximately 2 hours on an
871 EliteBook and requires approximately 20GB storage.
873 \item Finally you will want to have the icons on your desktop
874 (already default) and then click \textit{Finish}.
877 Then to install the \CGG{} tar files, you will need to start a
878 cygwin console terminal from the startup menu as shown here:
879 \texttt{Start $\rightarrow$ Cygwin $\rightarrow$ Cygwin64}
882 \subsection*{Installing \CGG{}}
883 \label{sec:installing_cinelerra}
886 \item Download the tar file
887 \href{https://cinelerra-gg.org/download/testing/libxcb-bld.tar.bz2}{libxcb-bld.tar.bz2}.
889 \item Install libxcb from the tar file -- installs into
890 \texttt{/usr/local} and requires approximately 21MB storage.
891 \begin{lstlisting}[style=sh]
892 tar -C /usr/local -xJf /path/libxcb-bld.tar.bz2
894 The libxcb patch repairs an error (XIOError), which stops
897 \item Download the tar file
898 \href{https://cinelerra-gg.org/download/testing/cygcin-bld.tar.bz2}{cygcin-bld.tar.bz2}.
900 \item Install cygcin from the tar file - this installs into home
901 directory. Note this is cygcin \emph{not} cygwin. You must change the
902 \texttt{path} below to the name of the path where you downloaded
904 \begin{lstlisting}[style=sh]
906 tar -xJf /path/cygcin-bld.tar.bz2
910 This creates \texttt{\~{}/cygcin}, a user build installation of
911 \CGG{} and requires approximately 400MB storage.
913 \paragraph{Running \CGG{}:}
914 You will need to start a cygwin desktop from the startup menu:
916 \item \texttt{Start$\rightarrow$ Cygwin-X $\rightarrow$ Openbox}
918 You should start a console controlling terminal so that you can
921 \item \texttt{Start$\rightarrow$ Cygwin $\rightarrow$ Cygwin64} Terminal
923 This opens a separate window that can survive a cygwin hang and
924 bugs. Without these logs, it is much more difficult to use.
926 \item Type into that console controlling window, the following:
927 \begin{lstlisting}[style=sh]
931 \item Change directories to where \CGG{} is installed:
932 \begin{lstlisting}[style=sh]
933 cd /path/cygcin (NOT cygwin)
937 \begin{lstlisting}[style=sh]
940 which starts up your 4 \CGG{} windows.
943 The most noticeable difference from the Linux versions is that
944 \CGG{} seems to run very slowly on Windows 10. You must be very
945 tolerant and patient to see this work. It can however exhibit
946 astonishing speed when encoding. \CGG{} has to be downgraded
947 significantly due to lack of supported interfaces, codecs (for
948 example h264/h265), and utilities. The only graphics driver is
949 X11 and the only sound driver is pulseaudio. Almost all
950 configurable omissions are applied to this build.
952 \paragraph{\CGG{} build on cygwin from source code:}
955 \item Download and install ffmpeg into /usr/local :
957 download ffmpeg (currently 4.2.2)
958 \begin{lstlisting}[style=sh]
960 tar -xJf /path/ffmpeg-4.2.2.tar.bz2
967 \item Download and install a patched libxcb:
968 \begin{lstlisting}[style=sh]
971 tar -xf /path/libxcb-1.13.tar.bz2
973 patch -p1 < /path/cinelerra-5.1/thirdparty/src/libxcb.patch1
974 patching file configure.ac
975 patching file src/xcb_in.c
981 \item Download cinelerra-gg:
982 \begin{lstlisting}[style=sh]
984 git clone "git://git.cinelerra-gg.org/goodguy/cinelerra.git"
985 cd cinelerra-gg/cinelerra-5.1
987 \item Apply cygwin patch:
988 \begin{lstlisting}[style=sh]
989 patch -p2 < blds/cygwin.patch
991 \item Run the build with:
992 \begin{lstlisting}[style=sh]
997 This produces a directory: /build\_path/cinelerra-gg/cinelerra-5.1/bin
998 which is used to create the cygcin archive.
1000 Currently, the targets are not stripped and can be run from gdb.
1001 There is only very limited signal handler dmp file support.
1002 Running gdb from inside a desktop resident console (not a cygwin64
1003 window) will hang cygwin (and cin) when it hits a breakpoint. You
1004 must run from an external console window to avoid this issue.
1007 \section{Distro with \CGG{} Included}%
1008 \label{sec:distro_with_cinelerra_included}
1009 \index{linux distro}
1011 There are also some special complete distribution systems
1012 available that include \CGG{} for audio and video production
1015 \subsection{AV Linux}
1016 \label{sec:AV_Linux}
1018 \textbf{AV Linux} is a downloadable/installable shared snapshot
1019 ISO image based on MX Linux. It provides the user an easy method to
1020 get an Audio and Video production workstation without the hassle
1021 of trying to find and install all of the usual components
1022 themselves. Of course, it includes \CGG{}!
1025 \href{http://www.bandshed.net/avlinux/}{homepage of AV Linux}.
1027 \subsection{Bodhi Linux Media}
1028 \label{sec:Bodhi_Linux}
1030 \textbf{Bodhi Linux Media} is a free and open source distribution that
1031 comes with a curated list of open source software for digital
1032 artists who work with audio, video, includes \CGG{}, games,
1033 graphics, animations, physical computing, etc.
1036 \href{https://gitlab.com/giuseppetorre/bodhilinuxmedia}{homepage of Bodhi Linux}.
1038 \subsection{DeLinuxCo}
1039 \label{sec:delinuxco}
1041 \textbf{DeLinuxCo} is a distro derived from Manjaro (so Arch based) with DE Cinammon. It is a professional workstation, mainly oriented to the multimedia field but not only. It contains many specialized programs already configured, including \CGG{}.
1043 You can read all about DeLinuxCo \href{https://www.delinuxco.com/}{here} and download \href{https://www.delinuxco.com/download/}{here}.
1048 \textbf{Elive}, or Enlightenment live CD, is a non-commercial, cost-free operating system based on Debian, and it can be used either as a live CD or an 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.
1050 Click \href{https://www.elivecd.org/}{Elive} for more information. The \CGG{} packages for the program
1051 and the manual are in the direcotry at
1052 \href{https://repo.bullseye.elive.elivecd.org/pool/multimedia/c/} {Bullseye version 11} and
1053 \href{http://repo.buster.elive.elivecd.org/pool/multimedia/c/}{Buster version 10} - just download
1054 the .deb files inside that directory and install via “dpkg -i “.
1056 \section{Cinx and a “Bit” of Confusion}%
1057 \label{sec:cinx_and_a_bit_of_confusion}
1060 Cinx is the exact same program as Cin. The X (x) represents the
1061 roman numeral 10 for 10-bit as opposed to 8-bit standard. The
1062 third-party library used for x265 must be specially compiled with
1063 \texttt{--bit-depth=10} in order to produce 10-bit rendered
1064 output. A cinx version can be built for most other distros if
1065 rendering at 10-bit is desirable instead of 8-bit.
1067 This build will not be able to output 8-bit depth which means you
1068 have to retain the Cin version also.
1070 Whatever build ffmpeg is linked to will determine what bit depth
1071 it can output. This is why there have to be separate builds. If
1072 you install both packages, Cin and CinX, you may get \textit{file
1073 conflicts of same file name} --- just continue.
1075 Keep in mind that the regular 8-bit version works on 8-bit bytes
1076 --- the standard word size for computers, but the 10-bit version
1077 has to use 2 words to contain all 10 bits so you can expect
1078 rendering to be as much as twice as slow.
1080 There is also a 12-bit version for consideration but currently the
1081 results are simply the same as 10-bit with padding to make 12-bit
1082 so it is of no value.
1084 \section{Multibit build for x265-8/10/12-bit}%
1085 \label{sec:multibit_build}
1088 To build a version that can handle 8 bit, or 10 bit, or 12 bit videos,
1089 a patch is provided in the \texttt{thirdparty} subdirectory that needs
1090 to be applied to do so. Be aware that the compile may take more time
1091 and seems to be about twice as long. To apply the required patch:
1093 \begin{lstlisting}[style=sh]
1094 cd /path/to/cinelerra-5.1/thirdparty
1095 patch < compile_multibit_X265.txt
1096 mv x265_3.5.patch* src/.
1098 Render formats \textit{h265-10bit} and \textit{h265-12bit} have been provided and will
1099 be operational after the applied patch is compiled in.
1101 %%% Local Variables:
1103 %%% TeX-master: "../CinelerraGG_Manual"