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 that currently works on older distros but may not work on the newest distros
15 (most of the popular Linux distributions such
16 as Arch, Ubuntu, and Fedora have dropped support for this older architecture). In any case, if you are using a 32-bit Linux distro, you should compile your sources from git or use a precompiled binary\protect\footnote{Remember that a 32-bit distro does not address more than 4GB of memory, so you may have stability and performance problems with large, high-resolution mediafiles.}. And there is 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:
18 Download the file from:
20 \url{https://cinelerra-gg.org/download/images/}
22 Some example file names are as follows - where 8 digits represent yyyymmdd:
24 \begin{lstlisting}[style=sh]
25 CinGG-20220131-x86_64.AppImage
26 (currently based on Fedora 32, linux kernel 5.8.15, libc version 2.31)
27 CinGG-20220131-x86_64-older-distros.AppImage
28 (currently based on Ubuntu 16.04, libc version 2.23)
29 CinGG-20220131-i686.AppImage
30 (currently based on Debian 9, linux kernel 4.9, use "newer" for Debian 11.0)
31 CinGG-20220131-i686-newer-distros.AppImage
32 (currently based on Debian 11, linux kernel 5.10)
33 CinGG-20220131-x86_64-multibit.AppImage
34 (currently based on Fedora 32, libc version 2.31)
35 CinGG-20220131-x86_64-older-distros-multibit.AppImage
36 (currently based on Fedora 29 - runs on RHEL8 - linux kernel 4.19.9, libc version 2.28)
39 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:
41 \begin{lstlisting}[style=sh]
42 $ chmod u+x CinGG-yyyymmdd.AppImage
45 Finally start the program from a window in the directory where the image is stored:
47 \begin{lstlisting}[style=sh]
48 $ ./CinGG-yyyymmdd.AppImpage
51 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
52 description of a GUI methodology for doing so in this file on the webiste:
54 \url{https://cinelerra-gg.org/download/images/README\_appimage.txt}
56 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.
58 \begin{lstlisting}[style=sh]
59 sudo pacman -S libappimage
62 And Leap 15.3 (OpenSUSE) requires installation of the \textit{appimage} package.
64 \begin{lstlisting}[style=sh]
65 sudo zypper se -is appimage
68 In addition, if you are using the OpenGL video driver, you will need to install the appropriate OpenGL
69 drivers for your Operating System graphics board because libGLU.so and other OpenGL libraries are
70 not included in the AppImage.
72 \section{Download Already Built \CGG{}}%
73 \label{sec:download_already_built_cinelerra_gg}
77 \includegraphics[width=1.0\linewidth]{download-distros.png}
78 \caption{Screencast of the website Download page for installing \CGG{} for various O/S.}
79 \label{fig:download-distros}
82 All of these images are dated 10/31/2020 and are no longer being maintained. They
83 will still work on the version of the O/S in use at that time but will have none of
84 the latest features. You should use the simpler AppImage instead as described previously.
86 If you prefer to not have to take the time to build \CGG{} Infinity
87 yourself, there are pre-built dynamic or static binaries for various
88 versions of Ubuntu, Mint, Suse, Fedora, Debian, Centos, Arch, and
89 Slackware linux as well as Gentoo and FreeBSD. If you do want to build it yourself so that
90 you get the added benefit of the latest checked in changes, please reference
91 ~\ref{sec:How_to_build}.
93 A Windows 10 version installation is described in~\ref{sec:ms_windows10}. There are also 32-bit i686 Ubuntu, Debian,
94 and Slackware versions available\protect\footnote{Remember that a 32-bit distro does not address more than 4GB of memory, so you may have stability and performance problems with large, high-resolution mediafiles.}. \textbf{These binaries are no longer being updated; they are stable and working but without future functionality}.
95 They are in subdirectories of:
98 \item \href{https://cinelerra-gg.org/download/tars}{https://cinelerra-gg.org/download/tars}
99 \item \href{https://cinelerra-gg.org/download/pkgs}{https://cinelerra-gg.org/download/pkgs}
102 The \textbf{tars} \index{tars} directory contains single-user static builds for
105 This is the recommended usage of \CGG{} because all of the files
106 will exist in a single directory. Generally all of the necessary
107 libraries are built into the static build, but in some cases you may
108 have to install another library that is being called for.
110 To install the single user builds, download the designated tarball
111 from the \texttt{./tars} subdirectory and unpack as indicated below:
113 \begin{lstlisting}[style=sh]
117 tar -xJf /src/path/cinelerra-5.1-*.txz # for the *, substitute your distro tarball name
120 \emph{Do not download the LEAP 10-bit version unless you specifically want to
121 use h265 rendering to 10-bit instead of the more standard 8-bit.} For more
122 information see ~\ref{sec:cinx_and_a_bit_of_confusion}.
124 The \textbf{pkgs} \index{pkgs} directory contains the standard packaged
125 application for various distros. This will install a dynamic
126 system version for users who prefer to have the binaries in the
127 system area and for multi-user systems.
129 In addition, performing the package install checks the md5sum in
130 the file \texttt{md5sum.txt} to ensure the channel correctly
131 transmits the package. There is a
132 \href{https://cinelerra-gg.org/download/README.pkgs}{README.pkgs}
133 file in the \texttt{download} directory with instructions so you
134 can \textit{cut and paste} and avoid typos; it is also shown
137 \lstset{inputpath=extra/}
140 basicstyle=\footnotesize,
141 caption={README.pkgs}
144 \section{How to Build \CGG{} from Developer's Git Repository}%
145 \label{sec:How_to_build}
149 These are generic build instructions for building \CGG{} Infinity.
150 Known to work on Ubuntu, Mint, OpenSuse, Fedora, Debian, Centos,
151 Arch, Slackware, and Gentoo. Compiling from git is perhaps the best way to get \CGG{} on 32-bit systems\protect\footnote{Remember that a 32-bit distro does not address more than 4GB of memory, so you may have stability and performance problems with large, high-resolution mediafiles.}. It has not been tested on every
152 single possible distro yet so you might expect to have to make
153 some minor changes. Also works on a somewhat limited basis on
154 FreeBSD and Windows 10 with the bsd.patch for FreeBSD and the
155 cygwin.patch for Windows 10. As of 10/31/2020, FreeBSD and Windows
156 10 builds and patches are no longer being maintained so that they
157 will work using the GIT version in use at that time but you will
158 have to create new patches for arising problems on later GITs.
160 NOTE: as of May 31, 2021 when Context Help was added, to include
161 this Context Help you will need to download the corresponding
162 tgz file containing the HTML manual sections referenced for the
163 Help pages. The file to download is:
164 \url{https://cinelerra-gg.org/download/images/HTML_Manual-20220131.tgz}
165 substituting for "20220131" the "yyyymmdd" representing latest release date.
166 Then unpack to your Cinelerra/bin/doc directory so it is included in
170 Alternatively, there are some pre-built dynamic or static binaries
171 which are updated on a fairly regular basis (as long as code changes
172 have been made) available at the link below.
174 \href{https://cinelerra-gg.org/download/}{https://cinelerra-gg.org/download/}
177 There are 2 kinds of builds, the default system-build and a
178 single-user build. A system build has results which are installed
179 to the system. The majority of the files are installed in the
180 standard system paths, but some customization is possible. The
181 single user build allows for running completely out of a local
182 user directory so it doesn't affect the system.
184 We recommend the single-user version when possible. It makes it
185 very easy to install a new version without having to delete the
186 older version in case you want it for backup -- once you are happy
187 with the new version, all you have to do is delete the entire old
188 directory path. Another reason for using single-user is that if
189 you install a new Operating System version and if you have \CGG{}
190 on separate disk space that is preserved, you won't have to
191 reinstall \CGG{}. It is also convenient for the purpose of having
192 the ability to interrupt or to see any possible error messages, if
193 you start the application from a terminal window command line
194 where you will have more control to catch problems. All that
195 said, the system builds can be useful in a university lab setting
196 where there are possibly multiple users, or multiple versions.
198 There are two notable differences between standard views
199 of \CGG{} and this implementation for the system builds. Both of
200 these can be configured during installation. The differences make
201 it possible to have several different versions installed without
202 having them interfere with each other.
205 \item application name can be set during a build but defaults
207 \item the home configuration directory can also be set and
208 traditionally defaults to: \texttt{\$HOME/.bcast5}
212 \subsection{The system build}
213 \label{sec:system-build}
216 To do a system build \index{build} , you should read the file
217 \texttt{README} that is at the top level after you get the source.
220 \item You need about 6.0 \,GB of disk storage to operate a build and
221 you need to have \textit{git} installed.
223 \item Obviously in order to install into the system, you must run as
226 \item The \textit{git:} step has to download many files (approx
227 130\,MB) so allow time. When decompressed this will expand to
230 \item Run the following commands (this takes awhile):
232 \begin{lstlisting}[style=sh]
233 # This is where you need the 6.0GB of disk space:
235 git clone --depth 1 "git://git.cinelerra-gg.org/goodguy/cinelerra.git" cinelerra5
236 # Change to the cloned directory:
237 cd cinelerra5/cinelerra-5.1
239 NOTE: if your system has never had \CGG{} Infinity installed, you
240 will have to make sure you have all of the compilers and libraries
241 necessary. So on the very first build you should run:
243 \begin{lstlisting}[style=sh]
244 ./blds/bld_prepare.sh <os> # where <os> represents the
245 # Operating System of
246 # centos, fedora, suse, ubuntu, mint, debian.
248 ./configure --prefix=/usr # optional parameters can be added here
249 make 2>&1 | tee log # make and log the build
252 \texttt{bld\_prepare.sh} does not work for Arch Linux or Gentoo,
253 so we have to install the dependencies
254 manually. \texttt{README.arch} or \texttt{README.gentoo}, which
255 contain the list of dependencies, can be found at:
257 \item \href{https://cinelerra-gg.org/download/README.arch}{https://cinelerra-gg.org/download/README.arch}
258 \item \href{https://cinelerra-gg.org/download/README.gentoo}{https://cinelerra-gg.org/download/README.gentoo}
261 \item Check for obvious build errors:
262 \begin{lstlisting}[style=sh]
263 grep "\*\*\*.*error" -ai log
265 If this reports errors and you need assistance or you think
266 improvements can be made to the builds, email the log which is
268 \href{mailto:cin@lists.cinelerra-gg.org}{cin@lists.cinelerra-gg.org}
269 \begin{lstlisting}[style=sh]
270 /<build_path>/cinelerra5/cinelerra-5.1/log
273 \item If there are no build errors, finally just run:
274 \begin{lstlisting}[style=sh]
277 Where <os> represents the Operating System supported by \CGG{}, such
278 as centos, fedora, suse, ubuntu, mint, debian.
279 The ``with-single-user'' parameter makes it so.
280 % Make and log build (
281 Check for errors before proceeding.
284 \item If it all worked, you are all setup. Just click on the \CGG{}
289 \subsection{The single-user build}
290 \label{sec:single-user-build}
291 \index{single-user build}
294 To do a single-user build, read the file \texttt{README} that is at
295 the top level after you get the source.
298 \item You need at least 6\,GB of disk storage to operate a build +
299 you need to have “\texttt{git}” installed.
301 \item Recommend you build and run as \textbf{root}, just to avoid
302 permission issues initially.
303 \item The \textit{git} step has to download many files (approx
304 130\,MB) so allow time.
306 \item Run the following commands (this takes awhile):
307 \begin{lstlisting}[style=sh]
308 # This is where you need the 6GB of disk space
310 git clone --depth 1 "git://git.cinelerra-gg.org/goodguy/cinelerra.git" cinelerra5
311 # Toplevel directory:
312 cd cinelerra5/cinelerra-5.1
316 NOTE: if your system has never had \CGG{} Infinity installed, you
317 will have to make sure all the compilers and libraries necessary are
318 installed. So on the very first build you should run as
321 % FIXME No novels in the listings.
322 \begin{lstlisting}[style=sh]
323 ./blds/bld_prepare.sh <os>
325 ./configure --with-single-user
329 Where <os> represents the Operating System supported by \CGG{}, such
330 as centos, fedora, suse, ubuntu, mint, debian.
331 The ``with-single-user'' parameter makes it so.
332 % Make and log build (
333 Check for errors before proceeding.
336 Then just start the application by keying in: \texttt{./cin} in the
337 bin subdirectory OR add a desktop icon by using the appropriate
338 directory to copy the files to, run as \textbf{root}, and edit to
339 correct the directory path. Below are generic directions of how to
342 Then just start the application by keying in: \texttt{./cin} in the
343 bin subdirectory OR add a desktop icon by using the appropriate
344 directory to copy the files to, run as \textbf{root}, and edit to
345 correct the directory path. Below are generic directions of how to
348 \begin{lstlisting}[style=sh]
349 cd /cinelerra_directory_path
350 cp -a image/cin.{svg,xpm} /usr/share/pixmaps/
351 cp -a image/cin.desktop /usr/share/applications/cin.desktop
354 After you have followed the above, in the cin.desktop file, change
355 the \texttt{Exec=cin} line to be
356 \texttt{Exec=<your\_directory\_path>/bin/cin}.
358 The preceding directions for doing a single-user build may work
359 without being root on some distros except for the \texttt{bld\_prepare.sh}
360 and creating the desktop icon. For example in Arch Linux installing without being root
361 works using the following steps:
363 \begin{lstlisting}[style=sh]
364 $ git clone --depth 1 "git://git.cinelerra-gg.org/goodguy/cinelerra.git" cinelerra5
365 $ cd /home/USER/cinelerra5/cinelerra-5.1
367 $ ./configure --prefix=/usr --with-single-user --with-booby
368 $ make 2>&1 | tee /tmp/cin5.log && make install
372 \subsection{Notable Options and Caveats}%
373 \label{sub:notable_options_and_caveats}
376 These procedures and the \CGG{} Infinity software have all been run
377 as \textbf{root} on various home laptops and desktops. This provides
378 the best chance to ensure all works correctly and also allows for
379 handling errors, other problems and potential crashes with the most
380 success. Included in this section are some of the build variations
381 easily available for normal builds.
383 To see the full list of features use:
385 \begin{lstlisting}[style=sh]
388 The default build \index{build} is a system build which uses:
390 \begin{lstlisting}[style=sh]
391 ./configure --without-single-user
394 In the single-user build \index{single-user build}, the target directory is always
395 \texttt{cin}. Because this is also the developer build, constant
396 names are used throughout. However, you can rename files after the
399 If your operating system has issues with the default install to
400 \texttt{/usr/local}, you might have to change the location to
401 \texttt{/usr} for a system build. Then you will have to use:
402 \begin{lstlisting}[style=sh]
403 ./configure --prefix=/usr
406 If you wish to change the default directory for a system build you
407 will have to add the destination directory path on the \texttt{make
408 install} line. For example:
409 \begin{lstlisting}[style=sh]
410 make install DESTDIR=<your selected target directory path>
413 The application name can be set during installation, but defaults to
414 \texttt{cin} so that the GG/Infinity build can coexist with other
415 \CGG{} builds if necessary. To override the default \texttt{cin}
417 \begin{lstlisting}[style=sh]
418 ./configure --with-exec-name=cinelerra
421 The home configuration directory can also be set, but default
422 location is traditionally \texttt{\$HOME/.bcast5}. For example:
424 \begin{lstlisting}[style=sh]
425 ./configure -with-config-dir=/myusername/.bcast5
428 NOTE: when you specify parameters to the configure program, it will
429 create a \texttt{make} file as a consequence. Since in a
430 \texttt{make} file, the \$ is a special character, it must be
431 escaped so in order to represent a \$ as part of an input parameter,
432 it has to be stuttered. That is, you will need \$\$ (2 dollar
433 signs) to represent a single dollar sign.
435 It may be necessary on some distros which have missing or incomplete
436 up-to-date libraries, to build \CGG{} without Ladspa. To do so,
439 \begin{lstlisting}[style=sh]
440 ./configure --prefix=/usr --without-ladspa-build
443 Note that the with-ladspa-dir is the ladspa search path, and
444 exists even if the ladspa build is not selected. This gives you
445 the ability to specify an alternate ladspa system path by
446 utilizing the \texttt{LADSPA\_PATH} environment variable (that is,
447 the default ladspa build is deselected).
449 Note for 32-bit 14.2 Slackware, Debian, Gentoo, Arch, FreeBSD,
450 before running the configure, you will need to set up the following:
452 \begin{lstlisting}[style=sh]
453 export ac_cv_header_xmmintrin_h=no
454 export FFMPEG_EXTRA_CFG=" --disable-vdpau"
457 NOTE: as of May 31, 2021 when Context Help was added, to include
458 this Context Help you will need to download the corresponding
459 tgz file containing the HTML manual sections referenced for the
460 Help pages. The file to download is:
461 \url{https://cinelerra-gg.org/download/images/HTML_Manual-20220131.tgz}
462 substituting for "20220131" the "yyyymmdd" representing latest release date.
463 Then unpack to your Cinelerra/bin/doc directory so it is included in
464 your built system. The reason for not including the HTML manual in
465 the source code so that it would already be there, is because it is
466 very large and has its own GIT base.
468 \subsection{Notes about Building from Git in your Customized Environment}%
469 \label{sub:notes_about_building_from_git_in_your_customized_environment}
474 Getting a build to work in a custom environment is not easy. If you
475 have already installed libraries which are normally in the
476 thirdparty build, getting them to be recognized means you have to
477 install the \textit{devel} version so the header files which match
478 the library interfaces exist. Below is the list of thirdparty
479 builds, but this list may have changed over time.
480 % It's list of Table?
484 \begin{longtable}{m{8em} c}
485 \caption{List of thirdparty builds}
486 \label{tab:List_of_thirdparty_builds}\\
529 The \textit{yes} means force build and \textit{auto} means probe and
530 use the system version if the build operation is not static. To get
531 your customized build to work, you need to change the probe options
532 for the conflicting libraries from \textit{yes} to \textit{auto}, or
533 even rework the \texttt{configure.ac} script. There may be several
534 libraries which need special treatment.
536 An example of a problem you might encounter with your customized
537 installation is with \texttt{a52dec} which has probes line
538 \texttt{(CHECK\_LIB/CHECK\_HEADERS)} in \texttt{configure.ac}, but
539 \texttt{djbfft} does not. In this case, \texttt{djbfft} is only
540 built because \texttt{a52dec} is built, so if your system has
541 \texttt{a52dec}, set \texttt{a52dec} to auto and see if that
542 problem is solved by retrying the build with:
543 \begin{lstlisting}[style=sh]
544 ./confgure --with-single-user -enable-a52dec=auto .
547 With persistence, you can get results, but it may take several tries
548 to stabilize the build. If you need help, email the \texttt{log}
549 and \texttt{config.log}, which is usually sufficient to determine
552 If you have already installed the \texttt{libfdk\_aac} development
553 package on your computer because you prefer this version over the
554 default aac, you will have to do the following to get this
555 alternative operational. The libfdk\_aac library is not a part of
556 \CGG{} by default because it is not license free.
558 \begin{lstlisting}[style=sh]
559 export FFMPEG_EXTRA_CFG=" --enable-libfdk-aac --enable-nonfree"
560 export EXTRA_LIBS=" -lfdk-aac"
561 for f in `grep -lw aac cinelerra-5.1/ffmpeg/audio/*`; do
562 sed -e 's/\<aac\>/libfdk_aac/' -i $f
567 \subsection{Cloning the Repository for Faster Updates}%
568 \label{sub:cloning_the_repository_for_faster_updates}
572 If you want to avoid downloading the software every time an update
573 is available you need to create a local ``repository'' or repo. The
574 repo is a directory where you first do a \texttt{git clone}. For
575 the initial git clone, set up a local area for the repository
576 storage, referred to as \texttt{<repo\_path>}. The \texttt{git
577 clone} creates a repo named \texttt{cin5} in the
578 \texttt{/<repo\_path>/} directory. This accesses about 530\,MB of
579 repo data, so the device has to have at least that available. The
580 repo path is always a perfect clone of the main repo.
583 \paragraph{Setting up the initial clone}%
584 \label{par:setting_up_the_initial_clone}
586 You may want to add ``\verb|--depth 1|'' before \texttt{cin5}
587 because this will clone faster and is smaller, but has no history.
589 \begin{lstlisting}[style=sh]
591 git clone "git://git.cinelerra-gg.org/goodguy/cinelerra" cin5
593 Cloning into "cin5"...
594 remote: Counting objects: 20032, done.
595 remote: Compressing objects: 100% (11647/11647), done.
596 remote: Total 20032 (delta 11333), reused 16632 (delta 8189)
597 Receiving objects: 100% (20032/20032), 395.29 MiB | 3.26 MiB/s, done.
598 Resolving deltas: 100% (11333/11333), done.
599 Checking connectivity... done.
603 \paragraph{Update an existing repo}%
604 \label{par:update_an_existing_repo}
605 The below shows how you can get updates.
607 \begin{lstlisting}[style=sh]
613 \paragraph{Useful git commands}%
614 \label{par:useful_git_commands}
615 Some other commands that are useful.
617 \begin{lstlisting}[style=sh]
618 git clone "git://git.cinelerra-gg.org/goodguy/cinelerra.git" cin5
619 git pull # pull remote changes to the local version
620 git status # shows changed files
621 git clean -i # interactive clean, use answer 1 to "clean"
625 \subsection{How to Build from a Previous GIT Version}%
626 \label{sub:how_to_build_from_a_previous_git_version}
631 If you have a problem with the current GIT version, you can revert
632 to a previous working version easily. The commands to use will be
633 similar to these next lines which are then explained in more detail.
636 \begin{lstlisting}[style=sh]
637 cd /<path>/cin5 # substitute your repo path name for cin5
638 git log # shows a list of versions depending on history depth specification
639 git checkout <version> # choose a version number as listed
642 The \texttt{git log} command produces a log file with hash values
643 for commit keys to the level specifed if the the depth paramter
645 The hash ids are the commit names to use when you
646 use git checkout. Next is displayed sample output:
648 \begin{lstlisting}[style=nil]
649 delete stray line in last checkin
651 commit 4a90ef3ae46465c0634f81916b79e279e4bd9961
652 Author: Good Guy <good1.2guy@gmail.com>
653 Date: Thu Feb 22 14:56:45 2018 -0700
655 nested clips, big rework and cleanup, sams new icons,
658 commit f87479bd556ea7db4afdd02297fc00977412b873
659 Author: Good Guy <good1.2guy@gmail.com>
660 Date: Sat Feb 17 18:09:22 2018 -0700
663 For the \texttt{git checkout <version>}, you would then keyin the
664 line below for the following results:
666 \begin{lstlisting}[style=nil]
667 git checkout f87479bd556ea7db4afdd02297fc00977412b873
669 Note: checking out 'f87479bd556ea7db4afdd02297fc00977412b873'.
671 You are in 'detached HEAD' state. You can look around, make
672 experimental changes and commit them, and you can discard any
673 commits you make in this state without impacting any branches by
674 performing another checkout.
676 If you want to create a new branch to retain commits you create,
677 you may do so (now or later) by using -b with the checkout command
680 git checkout -b <new-branch-name>
682 HEAD is now at f87479bd... more file size icon updates,
683 and more to followend
686 Later to get the repo back to current, use:
687 \begin{lstlisting}[style=sh]
692 \subsection{Debuggable Single User Build}%
693 \label{sub:debuggable_single_user_build}
694 \index{single-user build}
697 To build from source with full debugging symbols, first build a full
698 static (non\_debug) build as follows but instead of using
699 \texttt{/tmp} substitute your permanent disk path if you want to
702 \begin{lstlisting}[style=sh]
704 git clone --depth 1 "git://git.cinelerra-gg.org/goodguy/cinelerra.git" cinelerra5
705 cp -a /<repo_path>/cinelerra-5.1 /tmp/
706 cd /tmp/cinelerra-5.1
710 Then, to run as a developer in the debugger:
712 \begin{lstlisting}[style=sh]
713 CFLAGS="-O2 -ggdb" make -j8 rebuild_all
719 \subsection{Unbundled Builds}%
720 \label{sub:unbundled_builds}
725 There are some generic build scripts included in the \CGG{} GIT
726 repository for users who want to do unbundled builds with ffmpeg
727 already available on their system. This has been tested on Arch,
728 Ubuntu 18, FreeBSD, Windows10 and Leap 15 (rpm) at the time this
731 The names of the build scripts are: \texttt{arch.bld},
732 \texttt{bsd.bld}, \texttt{deb.bld}, \texttt{rpm.bld}, and
733 \texttt{cygwin.bld}. These scripts are in the \texttt{blds}
734 subdirectory. The \texttt{bsd.bld} should be used with the
735 \texttt{bsd.patch} file in that same directory. The
736 \texttt{cygwin.bld} should be used with the \texttt{cygwin.patch}
737 file in that same directory.
739 The reason that Cin Infinity traditionally uses its own thirdparty builds
740 (bundled builds) is because there are a lot of different distros
741 with varying levels of ffmpeg and other needed thirdparty
742 libraries. However, some users prefer using their current system
743 baseline without another/different copy of ffmpeg.
745 With different levels of the user’s libraries, uncertainty,
746 potential instability, and unknown issues may come up while
747 running \CGG{} and this will make it, for all practical purposes,
748 impossible to diagnose and debug problems or crashes.
750 There may be no help in these cases. You are encouraged to report
751 any errors which potentially originate from Cin Infinity, but if
752 the data indicates alternate library sources, please report the
753 problems to the appropriate maintainers.
755 With the unbundled builds, some features may not be available and
756 no attempt to comment them out has been made. So if you use a
757 pulldown, or pick a render option, or choose something that is not
758 available, it just will not work. For example, unless special
759 options were set up by you, the LV2 audio plugins will not be
760 available. Nor will the codec libzmpeg, the file codec ac3, or
761 DVD creation. The old school file classes will all work, but some
762 of the formats that come with ffmpeg may not because of the way
763 that ffmpeg was installed on your operating system. That is
764 because the \CGG{} included ffmpeg is a known static build and is
765 usually the latest stable/released version. For example, in the
766 current case of Leap 15, libx264 and libx265 are not built in and
767 this can be debilitating; you can always run \texttt{ffmpeg
768 -formats} and \texttt{ffmpeg -codecs} to see what is available
771 \section{Building the HTML Manual for Context Help}%
772 \label{sec:building_the_manual}
775 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.
777 The steps are as follows:
779 \item Download the manual in LaTeX:
781 \begin{lstlisting}[style=sh]
782 git clone "git://git.cinelerra-gg.org/goodguy/cin-manual-latex.git" master
785 \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):
786 \begin{lstlisting}[style=sh]
790 The steps that this script performs are as follows:
792 \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.
794 \begin{lstlisting}[style=sh]
795 pdflatex CinelerraGG_Manual.tex
796 makeindex CinelerraGG_Manual.idx
797 pdflatex CinelerraGG_Manual.tex
798 makeindex CinelerraGG_Manual.nlo -s nomencl.ist -o CinelerraGG_Manual.nls
799 pdflatex CinelerraGG_Manual.tex
802 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.
803 \item Next, to produce HTML output the script then moves (renames) \texttt{latex 2html-init} to \texttt{.latex2html-init} (starting with dot).
805 \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.
808 \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.
810 \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.
813 \section{Windows 10 with Cygwin for \CGG{} Limited}%
814 \label{sec:ms_windows10}
817 As of 10/31/2020, this is no longer being maintained. It should
818 still work using an older GIT version with Windows 10 but it is
819 possible with some effort to modify the patch file to work with the
822 To run \CGG{} on a Windows 10 computer, you will need to have
823 Cygwin installed on your system, along with the \CGG{} static tar
824 and a patched library: libxcb. This setup has been tested with
825 Windows 10, version 1909, on an HP EliteBook 820 at 2.3 GHz.
827 This limited version provides \textit{core} functionality at this
828 time with the standard Windows FFmpeg executable, meaning that
829 specific modifications in FFmpeg needed for \CGG{} are not
830 available. Limited capabilities include only a few render output
831 formats available - for example \textit{mov}, \textit{qt} as
832 \textit{mjpeg}, and \textit{mpeg} for videos and \textit{avi} and
833 \textit{qt} as \textit{s16le} for audio, but not \textit{mkv} or
834 \textit{mp4}. This is due to the fact that several codec and
835 utility libraries are not currently compiled to work with Windows.
837 \subsection*{Installing Cygwin}
838 \label{sec:installing_cygwin}
841 Cygwin is an environment that runs natively on Windows which
842 allows Unix programs to be compiled and run on Windows. With
843 cygwin installed on your Windows 10 computer, you will be able to
844 run \CGG{}. Before installing cygwin, you need to be warned that
845 the Avast anti-virus software kills files necessary for cygwin
846 installation and execution, so you will have to remove it and use
847 alternative anti-virus software (the standard default already
848 included with Windows 10 is Defender). Below are the steps for
852 \item Download cygwin for your 64-bit computer at:
853 \href{https://www.cygwin.com/}{https://www.cygwin.com/}
855 \item Generally just take the defaults as they show up, but the
856 next steps show what comes up.
858 \item When a warning window pops up, click \textit{Yes}.
860 \item Click \textit{Next}.
862 \item Choose \textit{Install from Internet} option and then click
865 \item Choose your desired directory by clicking on Browse
866 button. Choose \textit{All Users (Recommended)} and then click
869 \item Choose the local package directory where you would like your
870 installation files to be placed. Click \textit{Next}.
872 \item Choose \textit{Direct Connection} if you are using Internet
873 with plug and play device. Click \textit{Next}.
875 \item Choose any download site preferably
876 ``cygwin.mirror.constant.com'' and then click \textit{Next}.
878 \item For list of things to install, leave all set to
879 \textit{Default} except these to \textit{Install} instead:
888 This install takes a long time; approximately 2 hours on an
889 EliteBook and requires approximately 20GB storage.
891 \item Finally you will want to have the icons on your desktop
892 (already default) and then click \textit{Finish}.
895 Then to install the \CGG{} tar files, you will need to start a
896 cygwin console terminal from the startup menu as shown here:
897 \texttt{Start $\rightarrow$ Cygwin $\rightarrow$ Cygwin64}
900 \subsection*{Installing \CGG{}}
901 \label{sec:installing_cinelerra}
904 \item Download the tar file
905 \href{https://cinelerra-gg.org/download/testing/libxcb-bld.tar.bz2}{libxcb-bld.tar.bz2}.
907 \item Install libxcb from the tar file -- installs into
908 \texttt{/usr/local} and requires approximately 21MB storage.
909 \begin{lstlisting}[style=sh]
910 tar -C /usr/local -xJf /path/libxcb-bld.tar.bz2
912 The libxcb patch repairs an error (XIOError), which stops
915 \item Download the tar file
916 \href{https://cinelerra-gg.org/download/testing/cygcin-bld.tar.bz2}{cygcin-bld.tar.bz2}.
918 \item Install cygcin from the tar file - this installs into home
919 directory. Note this is cygcin \emph{not} cygwin. You must change the
920 \texttt{path} below to the name of the path where you downloaded
922 \begin{lstlisting}[style=sh]
924 tar -xJf /path/cygcin-bld.tar.bz2
928 This creates \texttt{\~{}/cygcin}, a user build installation of
929 \CGG{} and requires approximately 400MB storage.
931 \paragraph{Running \CGG{}:}
932 You will need to start a cygwin desktop from the startup menu:
934 \item \texttt{Start$\rightarrow$ Cygwin-X $\rightarrow$ Openbox}
936 You should start a console controlling terminal so that you can
939 \item \texttt{Start$\rightarrow$ Cygwin $\rightarrow$ Cygwin64} Terminal
941 This opens a separate window that can survive a cygwin hang and
942 bugs. Without these logs, it is much more difficult to use.
944 \item Type into that console controlling window, the following:
945 \begin{lstlisting}[style=sh]
949 \item Change directories to where \CGG{} is installed:
950 \begin{lstlisting}[style=sh]
951 cd /path/cygcin (NOT cygwin)
955 \begin{lstlisting}[style=sh]
958 which starts up your 4 \CGG{} windows.
961 The most noticeable difference from the Linux versions is that
962 \CGG{} seems to run very slowly on Windows 10. You must be very
963 tolerant and patient to see this work. It can however exhibit
964 astonishing speed when encoding. \CGG{} has to be downgraded
965 significantly due to lack of supported interfaces, codecs (for
966 example h264/h265), and utilities. The only graphics driver is
967 X11 and the only sound driver is pulseaudio. Almost all
968 configurable omissions are applied to this build.
970 \paragraph{\CGG{} build on cygwin from source code:}
973 \item Download and install ffmpeg into /usr/local :
975 download ffmpeg (currently 4.2.2)
976 \begin{lstlisting}[style=sh]
978 tar -xJf /path/ffmpeg-4.2.2.tar.bz2
985 \item Download and install a patched libxcb:
986 \begin{lstlisting}[style=sh]
989 tar -xf /path/libxcb-1.13.tar.bz2
991 patch -p1 < /path/cinelerra-5.1/thirdparty/src/libxcb.patch1
992 patching file configure.ac
993 patching file src/xcb_in.c
999 \item Download cinelerra-gg:
1000 \begin{lstlisting}[style=sh]
1002 git clone "git://git.cinelerra-gg.org/goodguy/cinelerra.git"
1003 cd cinelerra-gg/cinelerra-5.1
1005 \item Apply cygwin patch:
1006 \begin{lstlisting}[style=sh]
1007 patch -p2 < blds/cygwin.patch
1009 \item Run the build with:
1010 \begin{lstlisting}[style=sh]
1015 This produces a directory: /build\_path/cinelerra-gg/cinelerra-5.1/bin
1016 which is used to create the cygcin archive.
1018 Currently, the targets are not stripped and can be run from gdb.
1019 There is only very limited signal handler dmp file support.
1020 Running gdb from inside a desktop resident console (not a cygwin64
1021 window) will hang cygwin (and cin) when it hits a breakpoint. You
1022 must run from an external console window to avoid this issue.
1024 \section{Android Tablet or Phone with TERMUX}%
1025 \label{sec:android_termux}
1028 \CGG{} can be run on Android (without audio), a non-x86 mostly posix system,
1029 tablet or phone after installing TERMUX, the \textit{terminal emulator}.
1030 You will have to do your own build using the file in Cinelerra's
1031 \texttt{blds} subdirectory, \texttt{termux.bld}.
1032 Because this is a relatively new capability and of lesser use, some
1033 additional effort may have to be exerted on your part to get it going
1034 but it is easy to get help by contacting the mailing list.
1035 In addition, there is currently no known procedure for hearing audio.
1037 \begin{figure}[htpb]
1039 \includegraphics[width=1.0\linewidth]{android.png}
1040 \caption{Screencast of an Android tablet running \CGG{} using TERMUX.}
1044 Some requirements include;
1046 \item Termux runs with X on Android 7+.
1047 \item Install takes 5 GB of internal storage. In addition you can download videos,
1048 and other files with wget to one specific location at sdcard after running termux-setup-storage
1049 inside termux (it will prompt you to give access to sdcard graphically the first time used).
1050 \item If you have empty versions of \texttt{locale.alias}, \texttt{locale.dir},
1052 \newline \texttt{\$PREFIX/share/X11/locale/en\_US.UTF-8/XLC\_LOCALE}
1053 \newline you will have to request non-empty versions via the mailing list.
1054 \item Some helpful information on installing the X environment is at:
1055 \url{https://wiki.termux.com/wiki/Graphical\_Environment}
1056 \item To prevent crashing when loading a video file that has audio, use the guide
1057 \url{https://www.reddit.com/r/termux/comments/bpa8jz/pulseaudio\_streaming\_client/}
1058 which explains vnc/pulseaudio setup.
1061 A little more about Audio is presented next because you will need to have this running
1062 in order to prevent a crash (even though you still will not be able to hear audio) -- there does not seem to be a simple PA client in termux itself.
1063 Some information is available at:
1064 \url{https://android.stackexchange.com/questions/205576/how-to-play-sound-from-termux-when-using-linux} .
1066 The next few lines show a successful setup/usage.
1067 \begin{lstlisting}[style=sh]
1068 $ pulseaudio --start
1070 PID TTY STAT TIME MAJFL TRS DRS RSS %MEM COMMAND
1071 7003 pts/28 S<s 0:00 637 532 9039 1716 0.0 /data/data/com
1072 13684 ? S<l 0:00 0 49 123898 16616 0.8 pulseaudio --
1073 13692 pts/28 R<+ 0:00 0 63 7500 1420 0.0 ps axv
1075 \begin{lstlisting}[style=sh]
1076 $ pactl load-module module-native-protocol-tcp auth-ip-acl=127.0.0.1 auth-anonymous=116
1077 $ PULSE_SERVER=127.0.0.1 pactl info
1078 Server String: 127.0.0.1
1079 Library Protocol Version: 34
1080 Server Protocol Version: 34
1085 Host Name: localhost
1086 Server Name: pulseaudio
1087 Server Version: 14.2
1088 Default Sample Specification: s16le 2ch 44100Hz
1089 Default Channel Map: front-left,front-right
1090 Default Sink: OpenSL_ES_sink
1091 Default Source: OpenSL_ES_sink.monitor
1095 Now to start up \CGG{}, type in:
1096 \begin{lstlisting}[style=sh]
1097 $ cd (your cinelerra directory)/cinelerra/cinelerra-5.1/
1098 $ PULSE_SERVER=127.0.0.1 ./cin.sh
1101 You can even build a package version similiar to Debian, just with "\texttt{pkg search} pkg\_name / \texttt{pkg install}
1102 pkg\_name" instead of "\texttt{apt search/install} pkg\_name" and with "\texttt{*-static}" instead of "\texttt{*-dev/-devel} packages".
1103 For more information on this, see:
1105 \url{https://wiki.termux.com/wiki/Package\_Management}
1106 \newline \url{https://wiki.termux.com/wiki/Building\_packages}
1108 \section{Distro with \CGG{} Included}%
1109 \label{sec:distro_with_cinelerra_included}
1110 \index{linux distro}
1112 There are also some special complete distribution systems
1113 available that include \CGG{} for audio and video production
1116 \subsection{AV Linux}
1117 \label{sec:AV_Linux}
1119 \textbf{AV Linux} is a downloadable/installable shared snapshot
1120 ISO image based on MX Linux. It provides the user an easy method to
1121 get an Audio and Video production workstation without the hassle
1122 of trying to find and install all of the usual components
1123 themselves. Of course, it includes \CGG{}!
1126 \href{http://www.bandshed.net/avlinux/}{homepage of AV Linux}.
1128 \subsection{Bodhi Linux Media}
1129 \label{sec:Bodhi_Linux}
1131 \textbf{Bodhi Linux Media} is a free and open source distribution that
1132 comes with a curated list of open source software for digital
1133 artists who work with audio, video, includes \CGG{}, games,
1134 graphics, animations, physical computing, etc.
1137 \href{https://gitlab.com/giuseppetorre/bodhilinuxmedia}{homepage of Bodhi Linux}.
1139 \subsection{DeLinuxCo}
1140 \label{sec:delinuxco}
1142 \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{}.
1144 You can read all about DeLinuxCo \href{https://www.delinuxco.com/}{here} and download \href{https://www.delinuxco.com/download/}{here}.
1149 \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.
1151 Click \href{https://www.elivecd.org/}{Elive} for more information. The \CGG{} packages for the program
1152 and the manual are in the direcotry at
1153 \href{https://repo.bullseye.elive.elivecd.org/pool/multimedia/c/} {Bullseye version 11} and
1154 \href{http://repo.buster.elive.elivecd.org/pool/multimedia/c/}{Buster version 10} - just download
1155 the .deb files inside that directory and install via “dpkg -i “.
1157 \section{Cinx and a “Bit” of Confusion}%
1158 \label{sec:cinx_and_a_bit_of_confusion}
1161 Cinx is the exact same program as Cin. The X (x) represents the
1162 roman numeral 10 for 10-bit as opposed to 8-bit standard. The
1163 third-party library used for x265 must be specially compiled with
1164 \texttt{--bit-depth=10} in order to produce 10-bit rendered
1165 output. A cinx version can be built for most other distros if
1166 rendering at 10-bit is desirable instead of 8-bit.
1168 This build will not be able to output 8-bit depth which means you
1169 have to retain the Cin version also.
1171 Whatever build ffmpeg is linked to will determine what bit depth
1172 it can output. This is why there have to be separate builds. If
1173 you install both packages, Cin and CinX, you may get \textit{file
1174 conflicts of same file name} --- just continue.
1176 Keep in mind that the regular 8-bit version works on 8-bit bytes
1177 --- the standard word size for computers, but the 10-bit version
1178 has to use 2 words to contain all 10 bits so you can expect
1179 rendering to be as much as twice as slow.
1181 There is also a 12-bit version for consideration but currently the
1182 results are simply the same as 10-bit with padding to make 12-bit
1183 so it is of no value.
1185 \section{Multibit build for x265-8/10/12-bit}%
1186 \label{sec:multibit_build}
1189 To build a version that can handle 8 bit, or 10 bit, or 12 bit videos, a patch is provided in the \texttt{thirdparty} subdirectory that needs to be applied to do so. Be aware that the compile may take more time and seems to be about twice as long. To apply the required patch:
1191 \begin{lstlisting}[style=sh]
1192 cd /path/to/cinelerra-5.1/thirdparty
1193 patch < compile_multibit_X265.txt
1194 mv x265_3.5.patch* src/.
1196 Render formats \textit{h265-10bit} and \textit{h265-12bit} have been provided and will
1197 be operational after the applied patch is compiled in.
1199 %%% Local Variables:
1201 %%% TeX-master: "../CinelerraGG_Manual"