b35e81bd015c51856d5d25b1eeb96ca358e4b418
1 \chapter{Installation}
2 \label{cha:Installation}
3 \section{How to Build Cinelerra-GG from Developer's Git Repository}%
4 \label{sec:How_to_build}
6 These are generic build instructions for building Cinelerra-GG Infinity.
7 Known to work on Ubuntu, Mint, Suse/Leap, Fedora, Debian, Centos, Arch, and Slackware.
8 It has not been tested on every single possible distro yet so you might expect to have to make some minor changes.
10 Patches have been created to build on FreeBSD through the work of another programmer and a Gentoo version is being maintained elsewhere by another programmer.
12 Alternatively, there are some pre-built dynamic or static binaries which are updated on a fairly regular basis (as long as code changes have been made) available at the link below.
14 \begin{center}
16 \end{center}
18 There are 2 kinds of builds, the default system-build and a single-user build.
19 A system build has results which are installed to the system.
20 The majority of the files are installed in the standard system paths, but some customization is possible.
21 The single user build allows for running completely out of a local user directory so it doesn't affect the system.
23 We recommend the single-user version when possible.
24 It makes it very easy to install a new version without having to delete the older version in case you want it for backup -- once you are happy with the new version, all you have to do is delete the entire old directory path.
25 Also, if you install a new Operating System version and if you have Cinelerra on separate disk space that is preserved, you won't have to reinstall Cinelerra.
26 In addition for purposes of having the ability to interrupt or to see any possible error messages, if you start the application from a terminal window command line you will have more control to catch problems.
27 However, the system builds can be useful in a university lab setting where there are possibly multiple users, or multiple versions.
29 There are two notable differences between \textit{standard} views of Cinelerra and this implementation for the system builds.
30 Both of these can be configured during installation.
31 These differences make it possible to have several different versions installed without having them \textit{walk} on each other.
33 \begin{enumerate}
34     \item
35         application name can be set during installation and defaults to: \texttt{cin}
36     \item
37         the home configuration directory can also be set and defaults to:\\ \texttt{\$HOME/.bcast5} 38 \end{enumerate} 40 \paragraph{To do a system build,} you should read the \texttt{README} that is at the top level after you get the source. 43 \begin{enumerate} 44 \item 45 You need about 6.0 \,GB of disk storage to operate a build + you need to have \textit{git} installed. 46 \item Obviously in order to install into the system, you must run as \textbf{root}. 47 \item The \textit{git:} step has to download many files (approx 130\,MB) so allow time. When decompressed this will expand to about 530 MB. 48 \item Run the following commands (this takes awhile): 50 \begin{lstlisting}[language=bash,numbers=none] 51$ cd /<build_path>/           # this is where you need the 6.0GB of disk space
52 $git clone --depth 1 "git://git.cinelerra-gg.org/goodguy/cinelerra.git" cinelerra5 53$ cd cinelerra5/cinelerra-5.1 # toplevel directory
54         \end{lstlisting}
56         NOTE: if your system has never had Cinelerra-GG Infinity installed, you will have to make sure you have all of the compilers and libraries necessary.
57         So on the very first build you should run:
59         \begin{lstlisting}[language=bash,numbers=none]
60 $./blds/bld_prepare.sh <os> # where <os> represents the Operating System of Centos, Fedora, Suse, Leap, Ubuntu, Debian. 61$ ./autogen.sh
62 $./configure --prefix=/usr # optional parameters can be added here 63$ make 2>&1 | tee log        # make and log the build
64         \end{lstlisting}
65         \texttt{bld\_prepare.sh} does not work for Arch Linux, so we have to install the dependencies manually. \texttt{README.arch}, which contains the list of dependencies, can be found at: {\small \url{https://cinelerra-gg.org/download/pkgs/README.arch}}
66     \item  Check for obvious build errors:
67         \begin{lstlisting}[language=bash,numbers=none]
68 $grep "\*\*\*.*error" -ai log 69 \end{lstlisting} 70 If this reports errors and you need assistance or you think improvements can be made to the builds, 71 email the log which is listed below to: \href{mailto:cin@lists.cinelerra-gg.org}{cin@lists.cinelerra-gg.org} 72 \begin{lstlisting}[language=bash,numbers=none] 73$ /<build_path>/cinelerra5/cinelerra-5.1/log
74         \end{lstlisting}
75     \item  If there are no build errors, finally just run:
76         \begin{lstlisting}[language=bash,numbers=none]
77    $make install 78 \end{lstlisting} 79 \item If it all worked, you are all setup. Just click on the Cinelerra desktop icon. 80 \end{enumerate} 82 \paragraph{To do a single-user build,} read the \texttt{README} that is at the top level after you get the source. 83 \begin{enumerate} 84 \item You need at least 6\,GB of disk storage to operate a build + you need to have “\texttt{git}” installed. 85 \item Recommend you build and run as \textbf{root}, just to avoid permission issues initially. 86 \item The \textit{git} step has to download many files (approx 130\,MB) so allow time. 87 \item Run the following commands (this takes awhile): 88 \begin{lstlisting}[language=bash,numbers=none] 89$ cd /<build_path>/           # this is where you need the 6GB of disk space
90 $git clone --depth 1 "git://git.cinelerra-gg.org/goodguy/cinelerra.git" cinelerra5 91$ cd cinelerra5/cinelerra-5.1 # toplevel directory
92         \end{lstlisting}
93 \end{enumerate}
95 NOTE: if your system has never had Cinelerra-GG Infinity installed, you will have to make sure all
96 the compilers and libraries necessary are installed. So on the very first build you should run as \textbf{root}:
98 \begin{lstlisting}[language=bash,numbers=none]
99 $./blds/bld_prepare.sh <os> # where <os> represents the Operating System of centos, fedora, suse, leap, ubuntu, debian. 100$ ./autogen.sh
101 $./configure --with-single-user # the “with-single-user” parameter makes it so 102$ make 2>&1 | tee log            # make and log build (check for errors before proceeding)
103 $make install 104 \end{lstlisting} 106 Then just start the application by keying in: \texttt{./cin} in the bin subdirectory OR add a desktop icon by 107 using the appropriate directory to copy the files to, run as \textbf{root}, and edit to correct the directory path. 109 \begin{lstlisting}[language=bash,numbers=none] 110$ cd /cinelerra_directory_path
111 $cp -a image/cin.{svg,xpm} /usr/share/pixmaps/. 112$ cp -a image/cin.desktop /usr/share/applications/cin.desktop
113 \end{lstlisting}
114 Change the \texttt{Exec=cin} line to be \texttt{Exec=<your\_directory\_path>/bin/cin}
116 The preceding directions for doing a single-user build has been meticulously followed to build and run
117 on a newly installed ubuntu 15 system WITHOUT BEING ROOT except for the \texttt{bld\_prepare.sh} and creating the desktop icon.
119 \subsection{Notable Options and Caveats}%
120 \label{sub:notable_options_and_caveats}
122 These procedures and the Cinelerra-GG Infinity software have all been run as \textbf{root} on various home laptops and desktops. This provides the best chance to ensure all works correctly and also allows for handling errors, other problems and potential crashes with the most success.  Included in this section are some of the build variations easily available for normal builds.
124 To see the full list of features use:
126 \begin{lstlisting}[language=bash,numbers=none]
127 $./configure -help 128 \end{lstlisting} 129 The default build is a system build which uses: 131 \begin{lstlisting}[language=bash,numbers=none] 132$ ./configure -without-single-user
133 \end{lstlisting}
135 In the single-user build, the target directory is always \texttt{cin}.
136 Because this is also the developer build, constant names are used throughout.
137 However, you can rename files after the install is complete.
139 If your operating system has issues with the default install to \texttt{/usr/local}, you might have to change the location to \texttt{/usr} for a system build.  Then you will have to use:
140 \begin{lstlisting}[language=bash,numbers=none]
141 $./configure --prefix=/usr 142 \end{lstlisting} 144 If you wish to change the default directory for a system build you will have to add the destination directory path on the \texttt{make install} line. For example: 145 \begin{lstlisting}[language=bash,numbers=none] 146$ make install DESTDIR=<your selected target directory path>
147 \end{lstlisting}
149 The application name can be set during installation, but defaults to cin so that the GG/Infinity build can coexist with other Cinelerra builds if necessary.  To override the default \texttt{cin} name, use:
150 \begin{lstlisting}[language=bash,numbers=none]
151 $./configure --with-exec-name=cinelerra 152 \end{lstlisting} 154 The home configuration directory can also be set, but default location is \texttt{\$HOME/.bcast5}.
155 For example:
157 \begin{lstlisting}[language=bash,numbers=none]
158 $./configure -with-config-dir=/myusername/.bcast5 159 \end{lstlisting} 161 NOTE: when you specify parameters to the configure program, it will create a make file as a consequence. 162 Since in a make file, the \$ is a special character, it must be escaped so in order to represent a \$as part of an input parameter, it has to be stuttered. 163 That is, you will need \$\$(2 dollar signs) to represent a single dollar sign. 165 It may be necessary on some distros which have missing or incomplete up-to-date libraries, to build Cinelerra without Ladspa. 166 To do so, use: 168 \begin{lstlisting}[language=bash,numbers=none] 169$ ./configure --prefix=/usr --without-ladspa-build
170 \end{lstlisting}
172 Note that the with-ladspa-dir is the ladspa search path, and exists even if the ladspa build is not selected.  This gives you the ability to specify an alternate ladspa system path by utilizing the \texttt{LADSPA\_PATH} environment variable (that is, the default ladspa build is deselected).
174 Note for 32-bit 14.2 Slackware, Debian, Gentoo, Arch, FreeBSD, before running the configure, you will need to set up the following:
176 \begin{lstlisting}[language=bash,numbers=none]
177 $export ac_cv_header_xmmintrin_h=no 178$ export FFMPEG_EXTRA_CFG=" --disable-vdpau"
179 \end{lstlisting}
181 \subsection{Notes about Building from Git in your Customized Environment}%
184 Getting a build to work in a custom environment is not easy.  If you have already installed libraries which are normally in the thirdparty build, getting them to be recognized means you have to install the \textit{devel} version so the header files which match the library interfaces exist.  Below is the list of thirdparty builds, but this list may have changed over time.
185 % It's list of Table?
187 \begin{table}[htpb]
188     \centering
189     \caption{List of thirdparty builds}
190     \label{tab:List_of_thirdparty_builds}
191         \small
192     \begin{tabular}{m{8em}c}
193         \toprule
194         a52dec   & yes\\
195         djbfft   & yes\\
196         fdk      & auto\\
197         ffmpeg   & yes\\
198         fftw     & auto\\
199         flac     & auto\\
200         giflib   & yes\\
201         ilmbase&auto\\
202         lame    &  auto\\
203         libavc1394&auto\\
204         libraw1394&auto\\
205         libiec61883&auto\\
206         libdv     &auto\\
207         libjpeg   &auto\\
208         openjpeg  &auto\\
209         libogg    &auto\\
210         libsndfile&auto\\
211         libtheora&auto\\
212         libuuid  & yes\\
213         libvorbis&auto\\
214         mjpegtools&yes\\
215         openexr   &auto\\
216         tiff      &auto\\
217         twolame   &auto\\
218         x264      &auto\\
219         x265      &auto\\
220         libvpx  &auto\\
221         libwebp&auto\\
222         libaom& auto\\
223     \bottomrule
224     \end{tabular}
225 \end{table}
228 The \textit{yes} means force build and \textit{auto} means probe and use the system version if the build operation is not static.
229 To get your customized build to work, you need to change the probe options for the conflicting libraries from \textit{yes} to \textit{auto}, or even rework the \texttt{configure.ac} script.
230 There may be several libraries which need special treatment.
232 An example of a problem you might encounter with your customized installation is with \texttt{a52dec} which has probes line \texttt{(CHECK\_LIB/CHECK\_HEADER)} in \texttt{configure.ac}, but \texttt{djbfft} does not.
233 In this case, \texttt{djbfft} is only built because \texttt{a52dec} is built, so if your system has \texttt{a52dec}, set \texttt{a52dec} to auto and see if that problem is solved by retrying the build with:
234 \begin{lstlisting}[language=bash,numbers=none]
235 $./confgure --with-single-user -enable-a52dec=auto . 236 \end{lstlisting} 238 With persistence, you can get results, but it may take several tries to stabilize the build. 239 If you need help, email the \texttt{log} and \texttt{config.log}, which is usually sufficient to determine why a build failed. 240 %\vspace{5ex} 242 If you have already installed the \texttt{libfdk\_aac} development package on your computer because you prefer this version over the default aac, you will have to do the following to get this alternative operational. 244 \begin{lstlisting}[language=bash,numbers=none] 245$ export FFMPEG_EXTRA_CFG=" --enable-libfdk-aac --enable-nonfree"
246 $export EXTRA_LIBS=" -lfdk-aac" 247$ for f in grep -lw aac cinelerra-5.1/ffmpeg/audio/*; do
248 $sed -e 's/\<aac\>/libfdk_aac/' -i$f
249 $done 250 \end{lstlisting} 252 \subsection{Cloning the Repository for Faster Updates}% 253 \label{sub:cloning_the_repository_for_faster_updates} 255 If you want to avoid downloading the software every time an update is available you need to create a local "repository" or repo. 256 The repo is a directory where you first do a \texttt{git clone}. 257 For the initial git clone, setup a local area for the repository storage, referred to as \texttt{<repo\_path>}. 258 The \texttt{git clone} creates a repo named \texttt{cin5} in the \texttt{/<repo\_path>/} directory. 259 This accesses about 530\,MB of repo data, so the device has to have at least that available. 260 The repo path is always a perfect clone of the main repo. 262 \paragraph{Setting up the initial clone}% 263 \label{par:setting_up_the_initial_clone} 264 add "\texttt{ -{}-depth 1}" before \texttt{cin5} which is faster/smaller, but has no history. 266 \begin{lstlisting}[numbers=none] 267$ cd /<repo\_path>/
268 $git clone "git://git.cinelerra-gg.org/goodguy/cinelerra" cin5 270 Cloning into "cin5"... 271 remote: Counting objects: 20032, done. 272 remote: Compressing objects: 100% (11647/11647), done. 273 remote: Total 20032 (delta 11333), reused 16632 (delta 8189) 274 Receiving objects: 100% (20032/20032), 395.29 MiB | 3.26 MiB/s, done. 275 Resolving deltas: 100% (11333/11333), done. 276 Checking connectivity... done. 277 \end{lstlisting} 279 \paragraph{Update an existing repo}% 280 \label{par:update_an_existing_repo} 282 \begin{lstlisting}[language=bash,numbers=none] 283$ cd /<repo home>/cin5
284  $git pull 285 \end{lstlisting} 287 \paragraph{Useful git commands}% 288 \label{par:useful_git_commands} 291 \begin{lstlisting}[language=bash,numbers=none] 292$ git clone "git://git.cinelerra-gg.org/goodguy/cinelerra.git" cin5
293 $git pull # pull remote changes to the local version 294$ git status       # shows changed files
295 $git clean -i # interactive clean, use answer 1 to "clean" 296 \end{lstlisting} 300 \subsection{How to Build from a Previous GIT Version}% 301 \label{sub:how_to_build_from_a_previous_git_version} 304 \begin{lstlisting}[language=bash,numbers=none] 305$ cd /<path>/cin5_repo
306 $git log 307$ git checkout <version>
308 \end{lstlisting}
311 The \texttt{git log} command produces a log file with hash values for commit keys.  The hash ids are the commit names to use when you use git checkout.
312 Next is displayed sample output:
315 \begin{lstlisting}[numbers=none]
316 delete stray line in last checkin
318 commit 4a90ef3ae46465c0634f81916b79e279e4bd9961
319 Author: Good Guy <good1.2guy@gmail.com>
320 Date: Thu Feb 22 14:56:45 2018 -0700
322 nested clips, big rework and cleanup, sams new icons, leaks and tweaks
324 commit f87479bd556ea7db4afdd02297fc00977412b873
325 Author: Good Guy <good1.2guy@gmail.com>
326 Date: Sat Feb 17 18:09:22 2018 -0700
327 \end{lstlisting}
329 For the\texttt{ git checkout <version>}, you would then keyin the line below for the following results:
331 \begin{lstlisting}[numbers=none]
332 $git checkout f87479bd556ea7db4afdd02297fc00977412b873 334 Note: checking out 'f87479bd556ea7db4afdd02297fc00977412b873'. 336 You are in 'detached HEAD' state. You can look around, make experimental 337 changes and commit them, and you can discard any commits you make in this 338 state without impacting any branches by performing another checkout. 340 If you want to create a new branch to retain commits you create, you may 341 do so (now or later) by using -b with the checkout command again. Example: 343 git checkout -b <new-branch-name> 345 HEAD is now at f87479bd... more file size icon updates, and more to followend 346 \end{lstlisting} 348 Later to get the repo back to current, use: 349 \begin{lstlisting}[numbers=none] 350$ git checkout master
351 \end{lstlisting}
354 \subsection{Debuggable Single User Build}%
355 \label{sub:debuggable_single_user_build}
358 To build from source with full debugging symbols, first build a full static (non\_debug) build as follows but instead \texttt{/tmp} should be substituted with a permanent disk path if you want to keep it.
360 \begin{lstlisting}[numbers=none]
361 $git clone ... 362$ cp -a /path/cinelerra-5.1 /tmp/.
363 $cd /tmp/cinelerra-5.1 364$ ./bld.sh
365 \end{lstlisting}
368 Then, to run as a developer in the debugger:
370 \begin{lstlisting}[language=bash,numbers=none]
371 $CFLAGS="-O2 -ggdb" make -j8 rebuild_all 372$ cd cinelerra
373 $gdb ./ci 374 \end{lstlisting} 377 \subsection{Unbundled Builds}% 378 \label{sub:unbundled_builds} 380 There are some generic build scripts included in the Cinelerra-GG GIT repository for users who want to do unbundled builds with ffmpeg already available on their system. 381 This has been tested on Arch, Ubuntu 18, FreeBSD, and Leap 15 (rpm) at the time this was documented. 382 The names of the build scripts are: \texttt{arch.bld} , \texttt{bsd.bld} , \texttt{deb.bld} , and \texttt{rpm.bld}. 383 These scripts are in the \texttt{blds} subdirectory. 384 The \texttt{bsd.bld} should be used with the \texttt{bsd.patch} file in that same directory. 386 The reason that Cin Infinity traditionally uses thirdparty builds (bundled builds) is because there are a lot of different distros with varying levels of ffmpeg and other needed thirdparty libraries. 387 However, some users prefer using their current system baseline without another/different copy of ffmpeg. 388 With different levels of the user’s libraries, uncertainty, potential instability, and unknown issues may come up while running Cinelerra and this will make it, for all practical purposes, impossible to diagnose and debug problems or crashes. 389 There may be no help in these cases. You are encouraged to report any errors which potentially originate from Cin Infinity, but if the data indicates alternate library sources, please report the problems to the appropriate maintainers. 391 With the unbundled builds, some features may not be available and no attempt to comment them out has been made. 392 So if you use a pulldown, or pick a render option, or choose something that is not available, it just will not work. 393 For example, unless special options were set up by you, the LV2 audio plugins will not be available. 394 Nor will the codec libzmpeg, the file codec ac3, or DVD creation. 395 The old school file classes will all work, but some of the formats that come with ffmpeg may not because of the way that ffmpeg was installed on your operating system. 396 That is because the Cinelerra ffmpeg is a known static build and is usually the latest stable/released version. 397 In the current case of Leap 15, libx264 and libx265 are not built in and this can be debilitating; you can always run \texttt{ffmpeg -formats} and \texttt{ffmpeg -codecs} to see what is available on your system. 400 \section{Download Already Built Cinelerra-GG}% 401 \label{sec:download_already_built_cinelerra_gg} 403 If you prefer to not have to take the time to build Cinelerra-GG Infinity yourself, there are pre-built dynamic or static binaries for various versions of Ubuntu, Mint, Suse, Fedora, Debian, Centos, Arch, and Slackware linux as well as Gentoo and FreeBSD. 404 There are also 32-bit i686 Ubuntu, Debian, and Slackware versions available. 405 These are updated on a fairly regular basis as long as significant code changes have been made. 406 They are in subdirectories of: 408 {\small \url{https://cinelerra-gg.org/download/tars} 410 \url{https://cinelerra-gg.org/download/pkgs}} 412 The \textbf{tars} directory contains single-user static builds for different distros. 413 This is the recommended usage of Cinelerra-GG because all of the files will exist in a single directory. 414 To install the single user builds, download the designated tarball from the \texttt{./tars} subdirectory and unpack as indicated below: 416 \begin{lstlisting}[language=bash,numbers=none] 417$ cd /path
418 $mkdir cin 419$ cd cin
420 $tar -xJf /src/path/cinelerra-5.1-*.txz # for the *, substitute your distro tarball name 421 \end{lstlisting} 423 Do NOT download the LEAP 10-bit version unless you use h265 (it can't render 8-bit h265). 425 The \textbf{pkgs} directory contains the standard packaged application for various distros. 426 This will install a dynamic system version for users who prefer to have the binaries in the system area and for multi-user systems. 427 In addition, performing the package install checks the md5sum in the file \texttt{md5sum.txt} to ensure the channel correctly transmits the package. 428 There is a {\small \href{https://cinelerra-gg.org/download/pkgs/README.pkgs}{README.pkgs}} file in the \texttt{pkgs} directory with instructions so you can \textit{ cut and paste} and avoid typos; it is also shown next. 430 \begin{lstlisting}[numbers=none] 431 Depending on the distro, use the instructions below and select the appropriate 432 setup operations to install, update or remove cinelerr-gg infinity. (03/04/2019) 433 To upgrade, refresh repo, then replace "install" with "update", or whatever. 435 Email problems to cin@lists.cinelerra-gg.org 436 If repository problems, usually you can manually do an install by using: 437 wget https://cinelerra-gg.org/download/pkgs/{substitute_name}/cin_5.1.<sub_name>.deb 438 and install it manually, for example: dpkg -i cin_5.1.{substitute_filename}.deb 440 # GENTOO - courtesy Dominque Michel 441 # There is an ebuild package at this time as of 01/03/2019 at: 442 # https://svnweb.tuxfamily.org/listing.php?repname=proaudio%2Fproaudio&path= 443 # %2Ftrunk%2Foverlays%2Fproaudio%2Fmedia-video%2Fcinelerra%2F&#ab000caf7024d83112f42a7e8285f2f29 445 # FREEBSD - courtesy Yuri 446 # There is a port available at: https://www.freshports.org/multimedia/cinelerra-gg/ 447 # To use this port: cd /usr/ports/multimedia/cinelerra-gg && make install clean 448 # and then install this precompiled package via: pkg install cinelerra-gg 450 # FEDORA 451 # Replace the XX in fedoraXX in the next line with your current O/S version number 452 dnf install cinelerra --nogpgcheck --repofrompath cingg,https://cinelerra-gg.org/download/pkgs/fedoraXX/ 453 ##dnf erase cinelerra 455 # CENTOS 456 # Python 2 has been updated for other distros to Python 3 so you might have to create a soft link 457 # to get the correct version. For help, send email to cin@lists.cinelerra-gg.org 458 # first create the file /etc/yum.repos.d/cin_gg, with the following contents: 459 [cin_gg] 460 name=cingg 461 baseurl=https://cinelerra-gg.org/download/pkgs/centos7 462 gpgcheck=0 463 # end of cin_gg 464 yum install cinelerra 465 ##yum erase cinelerra 467 # UBUNTU, replace ub14 with your distro id: ub16,ub17,ub18 468 # Some ubuntu apt downloads register status as working 0% constantly while running the package 469 # download, like ubuntu 14. It may take a few minutes for this step so be patient. 470 apt install software-properties-common apt-transport-https 471 apt-add-repository https://cinelerra-gg.org/download/pkgs/ub14 472 # UBUNTU 16/17/18 note - This has been known to work, but things change quickly: 473 # VIP - for the first install, the above line adds Cinelerra to /etc/apt/sources.list but... 474 # Version 16/17/18 of Ubuntu are more strict for licensing so you will have to edit 475 # the file /etc/apt/sources.list to add [trusted=yes] after deb and before https...cin... 476 # For example the line should be: deb [trusted=yes] https://cinelerra-gg.org/download/pkgs/ub16 xenial main 477 # Or for ub17: deb [trusted=yes] https://cinelerra-gg.org/download/pkgs/ub17 zesty main 478 # Or for ub18: deb [trusted=yes] https://cinelerra-gg.org/download/pkgs/ub18 bionic main 479 # Also, on the install you will get an error message that you can either ignore as Cinelerra 480 # will run anyway, or else (the first time only) on the commnand line keyin: 481 # echo > /etc/sysctl.d/50-cin.conf "kernel.shmmax=0x7fffffff" 482 apt update 483 apt install cin 484 #to update a previous install (ignore any i386 errors as only 64 bit version available): 485 apt update 486 apt upgrade cin 487 ##apt remove cin 489 # MINT should use the same procedure as Ubuntu, but apt-add-repository does not seem to work, 490 # so use the GUI UpdateManager as follows: 491 # Administration->Software Sources->Additional Repositories->Add a new repository 492 # (Note instead of Administration, some versions of Mint GUI UpdateManager might be System) 493 # For Mint18,add: deb [trusted=yes] https://cinelerra-gg.org/download/pkgs/mint18 xenial main 494 # For Mint19,add: deb [trusted=yes] https://cinelerra-gg.org/download/pkgs/mint19 bionic main 495 # IMPORTANT NOTE: if you get "malformed input" error, you will have to create a file 496 # by typing the command: sudo touch /etc/apt/sources.list.d/additional-repositories.list 497 # then wait 10 minutes or so and try using the Gui Update Manager again. 498 apt update 499 apt install cin 500 #to update a previous install 501 apt update 502 apt upgrade cin 503 ##apt remove cin 505 # DEBIAN uses the same basic procedure as Ubuntu. 506 # The apt-add-repository varies per system so you will have to use your best judgement 507 apt install software-properties-common apt-transport-https 508 apt-add-repository https://cinelerra-gg.org/download/pkgs/debian8 509 OR apt-add-repository https://cinelerra-gg.org/download/pkgs/debian9 510 OR apt-add-repository https://cinelerra-gg.org/download/pkgs/debian10 511 # VIP - for the first install, the above line adds cinelerra to /etc/apt/sources.list but... 512 # Debian stretch/jessie/buster are more strict for licensing so you will have to edit 513 # the file /etc/apt/sources.list to add [trusted=yes] after deb and before https...cin... 514 # For example for debian8: deb [trusted=yes] https://cinelerra-gg.org/download/pkgs/debian8 jessie main 515 # For example for debian9: deb [trusted=yes] https://cinelerra-gg.org/download/pkgs/debian9 stretch main 516 # For example for debian10: deb [trusted=yes] https://cinelerra-gg.org/download/pkgs/debian10 buster main 517 apt update 518 apt install cin 519 #to update a previous install 520 apt update 521 apt upgrade cin 522 ##apt remove cin 524 # SUSE/LEAP 525 # (Note: you may have to zypper libavc and libiec versions if not already installed) 526 # cinelerra packages are unsigned so you will have to ignore: Package is not signed! 527 # openSUSE LEAP 15 528 zypper ar -f https://cinelerra-gg.org/download/pkgs/leap15/ cingg 529 zypper install -r cingg cinelerra # or cinelerra10bit for 10 bit 530 # openSUSE LEAP 42 531 zypper ar -f https://cinelerra-gg.org/download/pkgs/leap42/ cingg 532 # as of 42.3 SUSE there is a new requirement, so you will need to add: 533 zypper mr -G cingg 534 zypper install -r cingg cinelerra # or cinelerra10bit for 10 bit 535 ##zypper remove cinelerra # or cinelerra10bit for 10 bit 536 #to update a previous install (assuming you enabled autorefresh as above) 537 zypper refresh cingg 538 zypper up cinelerra # or cinelerra10bit for 10 bit 540 # SLACKWARE, substitute slk32 for slk64 and i486-1 for x86_64-1 541 wget -P /tmp https://cinelerra-gg.org/download/pkgs/slk64/cin-{date}-slk64-x86_64.txz 542 installpkg /tmp/cin... # name you used in the above line 543 #to update a previous install 544 upgradepkg /tmp/cin... # name you used in the above line 545 ##removepkg cin 547 # ARCH linux 548 # (A loosely defined list of packages that you should install first is listed in this file: 549 # https://www.cinelerra-gg.org/download/pkgs/README.arch ) 550 # first edit the file /etc/pacman.conf, to include the following: 551 [cingg] 552 SigLevel = Optional TrustAll 553 Server = https://cinelerra-gg.org/download/pkgs/arch 554 # end of cingg 555 # 556 # next run from a window the following 2 commands; 557 pacman -Syu 558 pacman -S cin 559 # NOTE: the first line above updates your Arch system to the current rolling release and the second 560 # line updates Cinelerra-GG based on the rolling release that was in effect on the last day of the month. 561 # Please complete the 2 steps above in order, one right after the other to avoid risk of a partial upgrade. 562 # Due to the unpredictability of when Arch libraries are updated, performing an install of Cinelerra at 563 # any time other than shortly after the last day of the month when the new build package is created, 564 # could lead to library incompatibilities. In that case, please consider using the Arch static tar file 565 # for installation instead. 566 #to remove a previous install 567 ##pacman -R cin 568 \end{lstlisting} 570 \section{Windows 10 with Cygwin for Cinelerra limited}% 571 \label{sec:ms_windows10} 573 To run Cinelerra on a Windows 10 computer, you will need to have Cygwin installed on your system, 574 along with the Cinelerra static tar and a patched library: libxbc. This setup has been tested 575 with Windows 10, version 1909, on an HP EliteBook 820 at 2.3 GHz. 577 This limited version provides \textit{core} functionality at this time with the standard Windows FFmpeg 578 executable, meaning that specific modifications in FFmpeg needed for Cinelerra are not available. 579 Limited capabilities include only a few render output formats available - for example \textit{mov}, \textit{qt} 580 as \textit{mjpeg}, and \textit{mpeg} for videos and \textit{avi} and \textit{qt} as \textit{s16le} 581 for audio, but not \textit{mkv} or \textit{mp4}. 582 This is due to the fact that several codec and utility libraries are not currently compiled to 583 work with Windows. 585 \underline{Installing Cygwin:} 587 Cygwin is an environment that runs natively on Windows which allows Unix programs to be compiled 588 and run on Windows. With cygwin installed on your Windows 10 computer, you will be able to run 589 Cinelerra. Before installing cygwin, you need to be warned that the Avast anti-virus software 590 kills files necessary for cygwin installation and execution, so you will have to remove it and 591 use alternative anti-virus software (the standard default already included with Windows 10 592 is Defender). Below are the steps for installation: 594 \begin{enumerate} 595 \item Download cygwin for your 64-bit computer at: {\small \url{https://www.cygwin.com/}} 596 \item Generally just take the defaults as they show up, but the next steps show what comes up. 597 \item When a warning window pops up, click \textit{Yes}. 598 \item Click \textit{Next}. 599 \item Choose \textit{Install from Internet} option and then click \textit{Next}. 600 \item Choose your desired directory by clicking on Browse button. Choose \textit{All Users (Recommended)} and then click \textit{Next}. 601 \item Choose the local package directory where you would like your installation files to be placed. Click \textit{Next}. 602 \item Choose \textit{Direct Connection} if you are using Internet with plug and play device. Click \textit{Next}. 603 \item Choose any download site preferably "cygwin.mirror.constant.com" and then click \textit{Next}. 604 \item For list of things to install, leave all set to \textit{Default} except these to \textit{Install} instead: 606 \begin{tabular}{ll} 607 base& devel\\ 608 gnome& graphics\\ 609 system& video\\ 610 X11 \\ 611 \end{tabular} 613 This install takes a long time; approximately 2 hours on an EliteBook and requires approximately 20GB storage. 614 \item Finally you will want to have the icons on your desktop (already default) and then click \textit{Finish}. 615 \end{enumerate} 617 Then to install the Cinelerra tar files, you will need to start a cygwin console terminal from the startup menu as shown here: 618 \texttt{Start$\rightarrow$Cygwin$\rightarrow$Cygwin64} Terminal 620 \underline{Installing Cinelerra:} 622 \begin{enumerate} 623 \item Download the tar file at:\\ 624 {\small \url{https://cinelerra-gg.org/download/testing/libxcb-bld.tar.bz2}} 625 \item Install libxbc from the tar file -- installs into \texttt{/usr/local} and requires approximately 21MB storage. 626 \begin{lstlisting}[language=bash,numbers=none] 627$ tar -C /usr/local -xJf /path/libxcb-bld.tar.bz2
628 \end{lstlisting}
629 The libxcb path repairs an error (XIOError), which stops the program.
632         \item Install cygcin from the tar file - this installs into home directory.  Note this is cygcin NOT cygwin.
633 \begin{lstlisting}[language=bash,numbers=none]
634         $cd 635$ tar -xJf /path/cygcin-bld.tar.bz2
636 \end{lstlisting}
637 \end{enumerate}
638 This creates \texttt{\~{}/cygcin} , a user build installation of Cinelerra and requires approximately 400MB storage.
640 \underline{Running Cinelerra:}
642 You will need to start a cygwin desktop from the startup menu:
643 \begin{enumerate}
644         \item \texttt{Start$\rightarrow$ Cygwin-X $\rightarrow$ Openbox}
646 You should start a console controlling terminal so that you can see program logging.
647         \item \texttt{Start$\rightarrow$ Cygwin $\rightarrow$ Cygwin64} Terminal
649 This opens a separate window that can survive a cygwin hang and bugs. Without these logs, it is much more difficult to use.
651         \item Type into that console controlling window, the following:
652 \begin{lstlisting}[language=bash,numbers=none]
653         $export DISPLAY=:0.0 654 \end{lstlisting} 655 \item Change directories to where Cinelerra is installed: 656 \begin{lstlisting}[language=bash,numbers=none] 657$ cd /path/cygcin    (NOT cygwin)
658 \end{lstlisting}
659         \item Finally keyin:
660 \begin{lstlisting}[language=bash,numbers=none]
661         $./cin 662 \end{lstlisting} 663 which starts up your 4 Cinelerra windows. 664 \end{enumerate} 666 The most noticeable difference from the Linux versions is that Cinelerra seems to run 667 very slowly on Windows 10. You must be very tolerant and patient to see this work. 668 It can however exhibit astonishing speed when encoding. Cinelerra has to be downgraded significantly due to lack of supported interfaces, codecs (for example h264/h265), and utilities. 669 The only graphics driver is X11 and the only sound driver is pulseaudio. Almost all configurable 670 omissions are applied to this build. 672 \underline{Cinelerra build on cygwin from source code:} 674 \begin{enumerate} 675 \item Download and install ffmpeg into /usr/local : 677 download ffmpeg (currently 4.2.2) 678 \begin{lstlisting}[language=bash,numbers=none] 679$ cd /tmp
680         $tar -xJf /path/ffmpeg-4.2.2.tar.bz2 681$ cd ffmpeg-4.2.2
682         $./configure 683$ make -j
684         $make install 685 \end{lstlisting} 686 \item Download and install a patched libxcb: 687 \begin{lstlisting}[language=bash,numbers=none] 688$ cd /tmp
689         $rm -rf libxcb-1.13/ 690$ tar -xf /path/libxcb-1.13.tar.bz2
691         $cd libxcb-1.13/ 692$ patch -p1 < /path/cinelerra-5.1/thirdparty/src/libxcb.patch1
693            patching file configure.ac
694            patching file src/xcb_in.c
695         $./autogen.sh 696$ ./configure
697         $make -j 698$ make install
699 \end{lstlisting}
701 \begin{lstlisting}[language=bash,numbers=none]
702         $cd /build_path/ 703$ git clone "git://git.cinelerra-gg.org/goodguy/cinelerra.git"
704         $cd cinelerra-gg/cinelerra-5.1 705 \end{lstlisting} 706 \item Apply cygwin patch: 707 \begin{lstlisting}[language=bash,numbers=none] 708$ patch -p2 < blds/cygwin.patch
709 \end{lstlisting}
710         \item Run the build with:
711 \begin{lstlisting}[language=bash,numbers=none]
712         $./blds/cygwin.bld 713 \end{lstlisting} 714 \end{enumerate} 716 This produces a directory:$/build\_path$/cinelerra-gg$/cinelerra\$-5.1/bin \newline
717 which is used to create the cygcin archive.
719 Currently, the targets are not stripped and can be run from gdb.
720 There is only very limited signal handler dmp file support.
721 Running gdb from inside a desktop resident console (not a cygwin64 window) will hang cygwin (and cin) when it hits a breakpoint.  You must run from an external console window to avoid this issue.
724 \section{Distribution Systems with Cinelerra Included}%
725 \label{sec:distribution_systems_with_cinelerra_included}
727 There are also some special complete distribution systems available that include Cinelerra-GG for audio and video production capabilities.
729 \textbf{AV Linux} is a downloadable/installable shared snapshot ISO image based on Debian.
730 It provides the user an easy method to get an Audio and Video production workstation without the hassle of trying to find and install all of the usual components themselves.
731 Of course, it includes Cinelerra-GG!
732 It is at:
734 \begin{center}
735         {\small \url{http://www.bandshed.net/avlinux/}}
736 \end{center}
738 \textbf{Bodhi Linux} is a free and open source distribution that comes with a curated list of open source software for digital artists who work with audio, video, includes Cinelerra GG, games, graphics, animations, physical computing, etc.
739 It is at:
741 \begin{center}
742         {\small \url{https://gitlab.com/giuseppetorre/bodhilinuxmedia}}
743 \end{center}
745 \section{Cinx and a “Bit” of Confusion}%
746 \label{sec:cinx_and_a_bit_of_confusion}
748 Cinx is the exact same program as Cin.
749 The X (x) represents the roman numeral 10 for 10-bit as opposed to 8-bit standard.
750 The third-party library used for x265 must be specially compiled with \texttt{--bit-depth=10} in order to produce 10-bit rendered output.
751 This build will not be able to output 8-bit depth which means you have to retain the Cin version also.
752 Whatever build ffmpeg is linked to will determine what bit depth it can output.
753 This is why there have to be separate builds.
754 If you install both packages, Cin and CinX, you may get \textit{file conflicts of same file name} --- just continue.
756 Keep in mind that the regular 8-bit version works on 8-bit bytes --- the standard word size for computers, but the 10-bit version has to use 2 words to contain all 10 bits so you can expect rendering to be as much as twice as slow.
757 There is also a 12-bit version for consideration but currently the results are simply the same as 10-bit with padding to make 12-bit so it is of no value.