MatN and Andrea reviewed changes
authorGood Guy <[email protected]>
Tue, 8 Sep 2020 15:50:51 +0000 (09:50 -0600)
committerGood Guy <[email protected]>
Tue, 8 Sep 2020 15:50:51 +0000 (09:50 -0600)
parts/Glossary.tex
parts/Installation.tex
parts/Introduction.tex
parts/Keyframes.tex
parts/Windows.tex

index 4e1de39365d267c6c6f9c727c1fcf04a597f8044..1037a895cb0ec328de81cacb9fae6f943899f31a 100644 (file)
 
 \nomenclature{\textbf{Gamut}}{In color reproduction, the gamut is a certain complete subset of colors. The larger the gamut of a device (associated with a color space) the more colors can be displayed.}
 
-\nomenclature{\textbf{HDR images}}{are images that have a dynamic range larger than that of the sensor used. They are created directly with a rendering or with the merge of several images at low dynamic range. They require the use of floating points.}
-
 \nomenclature{\textbf{HDTV}}{(high definition TV) standard characterized by a 16:9 aspect ratio, various frames rates and scan modes and with a resolution of at least 1080.}
 
 \nomenclature{\textbf{Lanczos}}{algorithm for high quality resampling video signal. It is also used in case of upsampling, weak point of other similar filters.}
index f68299085b3afd277f19d4bff60ac40d691a2b07..fcb40c7820118b75e4f9c411558bf21ec1e100f2 100644 (file)
@@ -1,5 +1,76 @@
 \chapter{Installation}
 \label{cha:Installation}
+
+\section{Download Already Built \CGG{}}%
+\label{sec:download_already_built_cinelerra_gg}
+
+\begin{figure}[htpb]
+       \centering
+       \includegraphics[width=1.0\linewidth]{download-distros.png}
+       \caption{Screencast of the website Download page for installing \CGG{} for various O/S.}
+       \label{fig:download-distros}
+\end{figure}
+
+If you prefer to not have to take the time to build \CGG{} 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.  If you do want to build it yourself so that
+you get the added benefit of the latest checked in changes, please reference
+~\ref{sec:How_to_build}.
+%
+A Windows 10 version installation is described in~\ref{sec:ms_windows10}.  There are also 32-bit i686 Ubuntu, Debian,
+and Slackware versions available.  These are updated on a fairly
+regular basis as long as significant code changes have been made.
+They are in subdirectories of:
+
+\begin{list}{}{}
+       \item \href{https://cinelerra-gg.org/download/tars}{https://cinelerra-gg.org/download/tars}
+       \item \href{https://cinelerra-gg.org/download/pkgs}{https://cinelerra-gg.org/download/pkgs}
+\end{list}
+
+The \textbf{tars} directory contains single-user static builds for
+different distros.
+%
+This is the recommended usage of \CGG{} because all of the files
+will exist in a single directory.  Generally all of the necessary
+libraries are built into the static build, but in some cases you may
+have to install another library that is being called for.
+%
+To install the single user builds, download the designated tarball
+from the \texttt{./tars} subdirectory and unpack as indicated below:
+
+\begin{lstlisting}[style=sh]
+       cd /path
+       mkdir cin
+       cd cin
+       tar -xJf /src/path/cinelerra-5.1-*.txz  # for the *,
+       # substitute your distro tarball name
+\end{lstlisting}
+
+\emph{Do not download the LEAP 10-bit version unless you specifically want to
+use h265 rendering to 10-bit instead of the more standard 8-bit.} For more
+information see ~\ref{sec:cinx_and_a_bit_of_confusion}.
+
+The \textbf{pkgs} directory contains the standard packaged
+application for various distros.  This will install a dynamic
+system version for users who prefer to have the binaries in the
+system area and for multi-user systems.
+%
+In addition, performing the package install checks the md5sum in
+the file \texttt{md5sum.txt} to ensure the channel correctly
+transmits the package.  There is a
+\href{https://cinelerra-gg.org/download/README.pkgs}{README.pkgs}
+file in the \texttt{download} directory with instructions so you
+can \textit{cut and paste} and avoid typos; it is also shown
+next.
+
+\lstset{inputpath=extra/}
+\lstinputlisting[
+style=nil,
+basicstyle=\footnotesize,
+caption={README.pkgs}
+]{README.pkgs}
+
 \section{How to Build \CGG{} from Developer's Git Repository}%
 \label{sec:How_to_build}
 
@@ -39,14 +110,14 @@ where you will have more control to catch problems.  All that
 said, the system builds can be useful in a university lab setting
 where there are possibly multiple users, or multiple versions.
 
-There are two notable differences between \textit{standard} views
+There are two notable differences between standard views
 of \CGG{} and this implementation for the system builds.  Both of
 these can be configured during installation.  The differences make
 it possible to have several different versions installed without
-having them \textit{walk} on each other.
+having them interfere with each other.
 
 \begin{enumerate}
-\item application name can be set during installation and defaults
+\item application name can be set during a build but defaults
   to: \texttt{cin}
 \item the home configuration directory can also be set and
   traditionally defaults to: \texttt{\$HOME/.bcast5}
@@ -196,9 +267,8 @@ After you have followed the above, in the cin.desktop file, change
 the \texttt{Exec=cin} line to be
 \texttt{Exec=<your\_directory\_path>/bin/cin}.
 
-The preceding directions for doing a single-user build have been
-meticulously followed to build and run on a newly installed ubuntu
-15 system WITHOUT BEING ROOT except for the \texttt{bld\_prepare.sh}
+The preceding directions for doing a single-user build may work
+without being root on some distros except for the \texttt{bld\_prepare.sh}
 and creating the desktop icon.
 
 
@@ -451,12 +521,14 @@ similar to these next lines which are then explained in more detail.
  
 \begin{lstlisting}[style=sh]
 cd /<path>/cin5  # substitute your repo path name for cin5
-git log                 # shows a list of versions
+git log                 # shows a list of versions depending on history depth specification
 git checkout <version> # choose a version number as listed
 \end{lstlisting}
 
 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
+for commit keys to the level specifed if the the depth paramter
+was specified. 
+The hash ids are the commit names to use when you
 use git checkout. Next is displayed sample output:
 
 \begin{lstlisting}[style=nil]
@@ -545,7 +617,7 @@ subdirectory.  The \texttt{bsd.bld} should be used with the
 \texttt{cygwin.bld} should be used with the \texttt{cygwin.patch}
 file in that same directory.
 
-The reason that Cin Infinity traditionally uses thirdparty builds
+The reason that Cin Infinity traditionally uses its own thirdparty builds
 (bundled builds) is because there are a lot of different distros
 with varying levels of ffmpeg and other needed thirdparty
 libraries.  However, some users prefer using their current system
@@ -577,75 +649,6 @@ this can be debilitating; you can always run \texttt{ffmpeg
   -formats} and \texttt{ffmpeg -codecs} to see what is available
 on your system.
 
-
-\section{Download Already Built \CGG{}}%
-\label{sec:download_already_built_cinelerra_gg}
-
-\begin{figure}[htpb]
-  \centering
-  \includegraphics[width=1.0\linewidth]{download-distros.png}
-  \caption{Screencast of the website Download page for installing \CGG{} for various O/S.}
-  \label{fig:download-distros}
-\end{figure}
-
-If you prefer to not have to take the time to build \CGG{} 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.
-%
-A Windows 10 version installation is described in~\ref{sec:ms_windows10}.  There are also 32-bit i686 Ubuntu, Debian,
-and Slackware versions available.  These are updated on a fairly
-regular basis as long as significant code changes have been made.
-They are in subdirectories of:
-
-\begin{list}{}{}
-\item \href{https://cinelerra-gg.org/download/tars}{https://cinelerra-gg.org/download/tars}
-\item \href{https://cinelerra-gg.org/download/pkgs}{https://cinelerra-gg.org/download/pkgs}
-\end{list}
-
-The \textbf{tars} directory contains single-user static builds for
-different distros.
-%
-This is the recommended usage of \CGG{} because all of the files
-will exist in a single directory.  Generally all of the necessary
-libraries are built into the static build, but in some cases you may
-have to install another library that is being called for.
-%
-To install the single user builds, download the designated tarball
-from the \texttt{./tars} subdirectory and unpack as indicated below:
-
-\begin{lstlisting}[style=sh]
-cd /path
-mkdir cin
-cd cin
-tar -xJf /src/path/cinelerra-5.1-*.txz  # for the *,
-                                        # substitute your
-                                        # distro tarball name
-\end{lstlisting}
-
-\emph{Do not download the LEAP 10-bit version unless you use h265 (it
-can't render 8-bit h265).}
-
-The \textbf{pkgs} directory contains the standard packaged
-application for various distros.  This will install a dynamic
-system version for users who prefer to have the binaries in the
-system area and for multi-user systems.
-%
-In addition, performing the package install checks the md5sum in
-the file \texttt{md5sum.txt} to ensure the channel correctly
-transmits the package.  There is a
-\href{https://cinelerra-gg.org/download/README.pkgs}{README.pkgs}
-file in the \texttt{download} directory with instructions so you
-can \textit{cut and paste} and avoid typos; it is also shown
-next.
-
-\lstset{inputpath=extra/}
-\lstinputlisting[
-style=nil,
-basicstyle=\footnotesize,
-caption={README.pkgs}
-]{README.pkgs}
-
 \section{Windows 10 with Cygwin for \CGG{} Limited}%
 \label{sec:ms_windows10}
 
@@ -884,7 +887,7 @@ Click here for the
 \subsection{Elive}
 \label{sec:elive}
 
-\textbf{Elive}, or Enlightenment live CD, is a non-commercial, cost-free operating system based on Debian, for the daily use and it can be used both as live CD or Installed system. Elive uses a customized Enlightenment desktop. It is fast, user-friendly and feature-rich and \CGG{} is included in the 64 bit version.\r
+\textbf{Elive}, or Enlightenment live CD, is a non-commercial, cost-free operating system based on Debian, for the daily use and it can be used both as live CD or Installed system. Elive uses a customized Enlightenment desktop. It is fast, user-friendly and feature-rich and \CGG{} is included in the 64 bit version.
 
 Click \href{https://www.elivecd.org/}{Elive} for more information.
 
@@ -895,7 +898,8 @@ Cinx is the exact same program as Cin.  The X (x) represents the
 roman numeral 10 for 10-bit as opposed to 8-bit standard.  The
 third-party library used for x265 must be specially compiled with
 \texttt{--bit-depth=10} in order to produce 10-bit rendered
-output.
+output.  A cinx version can be built for most other distros if 
+rendering at 10-bit is desirable instead of 8-bit.
 %
 This build will not be able to output 8-bit depth which means you
 have to retain the Cin version also.
index 31f4826fda4cb2ca09e39c72db470279848430c9..4939e72e4dff3c1da96a059a08467e8d2a40a6b8 100644 (file)
@@ -129,9 +129,10 @@ programmers.
                     \item Title plugin virtually unlimited script size with many changeable attributes such as size, blink, color.
                     \item Motion Graphics using the Sketcher plugin to create elements such as ellipses, rectangles and shapes for simpler motion graphics.
                     \item Open EDL for editing clips, nested clips, and xml files while working on a Project.
+                   \item File by Reference; To be able to modify the original source during editing (which, in this case, becomes destructive).
                     \item The Vectorscope option in the Videoscope plugin allows for the use of any number of user-supplied grid patterns as an Overlay.
-                    \item Hardware acceleration with vaapi and vdpau for computers with graphics boards meeting certain criteria.
-                    \item Bump Autos is a new type of autos that allows you to easily create and manage keyframes intervals in Speed, Fade and Camera/Projector-XYZ curves.
+                    \item Hardware acceleration with vaapi and vdpau for computers with graphics hardware meeting certain criteria.
+                    \item Bump Autos is a new type of keyframe automation that allows you to easily create and manage keyframes intervals in Speed, Fade and Camera/Projector-XYZ curves.
                 \end{itemize}
 \end{description}
 
@@ -161,7 +162,9 @@ And which chapters are important for beginning to learn to use \CGG{}. At the en
 
         Since this is important to not losing your work, you should read this chapter for some basic usage concepts and for some lesser used functions that may come in handy.
         Besides how to Load and Save files, there is also information on using raw camera formats.
-        Helpful hints on working with image sequences, such as a bunch of pictures from your camera all loaded at once, is a time saver.
+        Helpful hints on working with image sequences, such as a bunch of pictures from your camera all loaded at once, is a time saver. Understanding that the EDL is the list of changes that
+would be made to the original media in order to produce the desired output is key to ensuring
+that that media remains intact.
 
     \item[Chapter~\ref{cha:editing}] \nameref{cha:editing}.
 
@@ -183,7 +186,7 @@ And which chapters are important for beginning to learn to use \CGG{}. At the en
     \item[Chapter~\ref{cha:keyframes}] \nameref{cha:keyframes}.
 
         This is a more advanced topic but extremely useful to know.
-        Keyframes are data values that have been associated to the timeline that affect the media presentation.
+        Keyframes are data values that have been associated to media on the timeline that affect the media presentation.
         You can go for years without knowing all of the nuances but you will most likely have a need to use and understand them sooner or later.
 
     \item[Chapter~\ref{cha:ffmpeg_interactions}] \nameref{cha:ffmpeg_interactions}.
@@ -210,7 +213,7 @@ And which chapters are important for beginning to learn to use \CGG{}. At the en
 
     \item[Chapter~\ref{cha:capturing_recording_media}] \nameref{cha:capturing_recording_media}.
 
-        This chapter is helpful in learning how to capture and record media from various sources.  A section on using \CGG{} with broadcast TV is especially useful.
+        This chapter is helpful in learning how to capture and record media from various sources.  A section on using \CGG{} with broadcast TV (NTSC) is especially useful.
 
     \item[Chapter~\ref{cha:dvd_bluray_creation}] \nameref{cha:dvd_bluray_creation}.
 
index 310b4aae07dbcaa7d8140fe0c70b2bdebc5b125b..eac26a1913643cc8b1f8e2abc506e464686d2b8f 100644 (file)
@@ -1,7 +1,7 @@
 \chapter{Keyframes}%
 \label{cha:keyframes}
 
-The word \textit{keyframe} has at least 3 contextual meanings in the NLE environment.  First, the oldest meaning, is the \textit{I-Frame} definition used in codecs algorithms.  These are \textit{key} frames that begin a new sequence of pictures, and are anchor points for repositioning (seeks).  Next are the automation parameter data points.  These are usually input to primitive math forms, like translation and zoom.  And last are blobs of data that are chunks of parameters to plugins that can do almost anything.  The data can be a simple value, like a fader value, or more complex like a group of points and colors in a sketcher plugin keyframe.  The word keyframe has changed a lot in meaning.  In the context of \CGG{}, keyframes are data values that have been associated to the timeline which affect the media presentation.  So a keyframe no longer refers to a frame, but to a position on the timeline.
+The word \textit{keyframe} has at least 3 contextual meanings in the NLE environment.  First, the oldest meaning, is the \textit{I-Frame} definition used in codecs algorithms.  These are \textit{key} frames that begin a new sequence of pictures, and are anchor points for repositioning (seeks).  Next are the automation parameter data points.  These are usually input to primitive math forms, like translation and zoom.  And last are blobs of data that are chunks of parameters to plugins that can do almost anything.  The data can be a simple value, like a fader value, or more complex like a group of points and colors in a sketcher plugin keyframe.  The word keyframe has changed a lot in meaning.  In the context of \CGG{}, keyframes are data values that have been associated to media on the timeline which affect the media presentation.  So a keyframe no longer refers to a frame, but to a position on the timeline.
 
 In \CGG{}, there are two general types of keyframe data,
 \textit{automation keyframes} (autos) which are drawn as colored
index 6fc0eeb141b114471212b3f9bea9cd951508169f..474f3afcd34a8e3a1a31a154a042f4d9148fbc20 100644 (file)
@@ -58,7 +58,7 @@ you can adjust the horizontal and vertical size of the video and audio waveform
 Each track on the timeline has a set of attributes on its left side in the patchbay which is used to 
 control some options of that particular track. 
 
-Track Navigation is performed by selecting a video or audio track and moving to a certain time in the track. 
+Track navigation is performed by selecting a video or audio track and moving to a certain time in the track. 
 Use the vertical scroll bar to scan across tracks, or even easier you can use the mouse wheel. 
 And use the horizontal scroll bar to scan across time, or again even easier, you can use the mouse wheel with the Ctrl key.  
 
@@ -212,7 +212,7 @@ the \texttt{I-beam} in the Transport and Buttons bar. In figure~\ref{fig:inserti
 the green colored highlight \protect\footnote{green is used in the default Cakewalk theme, but the highlight color will be different in other themes} on the arrow icon indicating that you are currently in 
 \emph{drag and drop mode}.
 
-With the arrow highlighted for \emph{drag and drop mode}, a double click with the left mouse button in the timeline selects the edit the mouse pointer is over. 
+With the arrow highlighted for \emph{drag and drop mode}, a double click with the left mouse button (LMB) in the timeline selects the edit the mouse pointer is over. 
 Then dragging in the timeline repositions that edit and this can be used for moving effects,
 changing the order of playlists, or moving video pieces around. 
 There are numerous methods to cut and paste in \emph{drag and drop mode} by setting In/Out points to define
@@ -240,8 +240,7 @@ The In/Out points, displayed on the timebar by [ and ] brackets,  can be set in
 In the timebar, a colored bar will show between these 2 brackets to better outline the area selected.
 In \emph{drag and drop mode}, they are an easy way to define a selected region.
 
-It is important to remember that in \emph{cut and paste mode} and \emph{drag and drop mode}, a highlighted area 
-overrides the In/Out points. That is, if a highlighted area and In/Out points are both set, the highlighted area is changed by editing operations and the In/Out points are ignored. 
+It is important to remember that a highlighted area overrides the In/Out points. That is, if a highlighted area and In/Out points are both set, the highlighted area is changed by editing operations and the In/Out points are ignored. 
 But if no region is highlighted, the In/Out points are used. 
 To avoid confusion, use either highlighting or In/Out points but not both at the same time.
 
@@ -254,7 +253,7 @@ If you set the insertion point in another place when In/Out points are already s
 repositioned when you click the In/Out icon or keyboard equivalent. 
 If you click on In/Out points while a region is highlighted, the insertion point will be ignored and In/Out points will be set at the beginning and at the end of the highlighted area.
 
-When you select either the In or Out point on the timebar, the insertion point will move to that location.Note that when the insertion point is at the exact position of an In or Out point, the bracket will change
+When you select either the In or Out point on the timebar, the insertion point will move to that location. Note that when the insertion point is at the exact position of an In or Out point, the bracket will change
 color making it easy to see that you are exactly at that spot.
  
 If only the In point is set, when you click the In point icon the In point will be deleted.