Andrea recreated images + some fixups
[goodguy/cin-manual-latex.git] / parts / Stuff.tex
index 45a80977c097666cfbb5abf86a601f91d3df42c2..e15b1660b9c42821c55eafeab5e8f68a5d3d83fe 100644 (file)
@@ -1,7 +1,7 @@
 \chapter{How some stuff works}%
 \label{cha:how_stuff_works}
 
-This section describes in detail some areas of Cinelerra to help explain how things work.
+This section describes in detail some areas of \CGG{} to help explain how things work.
 
 \section{Copy/Paste and Highlight Usage}%
 \label{sec:copy_paste_highlight_usage}
@@ -21,7 +21,7 @@ All of the methods use window \textit{properties} to attach data, called a selec
 
 When a paste is used in a target window, the target program requests the advertised selection data.  This may access one of two buffers depending on which type of load/paste action is used.  The user loads a \textit{cut buffer} via Drag select or Ctrl-C/Ctrl-X, and pastes a \textit{cut buffer} via middle mouse press or Ctrl-V.
 
-\subsection*{Cinelerra cut and paste:}%
+\subsection*{\CGG{} cut and paste:}%
 \label{sub:cinelerra_cut_paste}
 
 \subsubsection*{1. Text cut and paste operations}%
@@ -32,20 +32,20 @@ To use a text selection, create a drag selection in textboxes by pressing and ho
 \subsubsection*{2. Media cut and paste operations}%
 \label{ssub:media_cut_paste_operations}
 
-To create a media selection, highlight a region on the Cinelerra media timeline, then use the main menubar or compositor/viewer edit panel to operate the clip cut, copy, or copy-keyframe menu buttons.  This selection can then be pasted to a target selection on the timeline using the main menubar or compositor/viewer edit panel to operate the clip paste or paste-keyframe operation.  Also, by using the resource window you can select the \textit{Clips} folder and right mouse the resources list box, then use the \textit{Paste Clip} menu item to paste the selection to a named clip.  Additionally, these methods work between running instances of Cinelerra, which means you can move media clips between the Cinelerra program instances.  The clip data is also copied to the secondary clipboard buffer.  This makes it possible to examine the clip content directly if so desired.
+To create a media selection, highlight a region on the \CGG{} media timeline, then use the main menubar or compositor/viewer edit panel to operate the clip cut, copy, or copy-keyframe menu buttons.  This selection can then be pasted to a target selection on the timeline using the main menubar or compositor/viewer edit panel to operate the clip paste or paste-keyframe operation.  Also, by using the resource window you can select the \textit{Clips} folder and right mouse the resources list box, then use the \textit{Paste Clip} menu item to paste the selection to a named clip.  Additionally, these methods work between running instances of \CGG{}, which means you can move media clips between the \CGG{} program instances.  The clip data is also copied to the secondary clipboard buffer.  This makes it possible to examine the clip content directly if so desired.
 
 \subsubsection*{3. The older cut\_buffer method}%
 \label{ssub:older_cut_buffer_method}
 
 \begin{itemize}
-    \item For text, if there is an active selection when a window closes, it uses \texttt{cut\_buffer0}.  Normally when a paste is performed, the target window \textit{notifies} the selection owner to \textit{send it now} when you do a paste, but if the window has closed there is no source window, so no pasting.  Some programs, like Cinelerra, use \texttt{cut\_buffer0} as a fallback.  This makes it possible to paste data from a closed window.
+    \item For text, if there is an active selection when a window closes, it uses \texttt{cut\_buffer0}.  Normally when a paste is performed, the target window \textit{notifies} the selection owner to \textit{send it now} when you do a paste, but if the window has closed there is no source window, so no pasting.  Some programs, like \CGG{}, use \texttt{cut\_buffer0} as a fallback.  This makes it possible to paste data from a closed window.
     \item To move media clip, data \texttt{cut\_buffer2} is used because it does not require the selection owner interface, and works simply and reliably.  This buffer is not normally in use by other programs.
 \end{itemize}
 
 \subsection*{Final note}%
 \label{sub:final_note}
 
-When a text selection is set, the selected text is redrawn using selected-highlight color when the textbox loses focus.  This convenience feature shows the active text selection as you move the pointer to the new target window.  When a new selection is set anywhere else on your screen, the current text selection will be redrawn using the inactive-highlight color as the textbox loses selection ownership.  In most Cinelerra themes, the drag selection text-highlight color is BLUE ($\#0000FF$), the selected-highlight color is SLBLUE ($\#6040C0$) -- really sort of purple, and the inactive-highlight color is MEGREY ($\#AFAFAF$).
+When a text selection is set, the selected text is redrawn using selected-highlight color when the textbox loses focus.  This convenience feature shows the active text selection as you move the pointer to the new target window.  When a new selection is set anywhere else on your screen, the current text selection will be redrawn using the inactive-highlight color as the textbox loses selection ownership.  In most \CGG{} themes, the drag selection text-highlight color is BLUE ($\#0000FF$), the selected-highlight color is SLBLUE ($\#6040C0$) -- really sort of purple, and the inactive-highlight color is MEGREY ($\#AFAFAF$).
 
 \section{Playing is Different than Seeking/Positioning!}%
 \label{sec:playing_seeking_positioning}
@@ -100,7 +100,7 @@ Figure~\ref{fig:cursor01} using the default \textit{playing} method where the fr
        \centering
        %\includegraphics[width=0.8\linewidth]{name.ext}
        \begin{tikzpicture}[scale=1, transform shape]
-       \node (img1) [yshift=0cm, xshift=0cm, rotate=0] {\includegraphics[width=0.6\linewidth]{images/cursor01.png}};    
+       \node (img1) [yshift=0cm, xshift=0cm, rotate=0] {\includegraphics[width=0.6\linewidth]{cursor01.png}};    
        \node [yshift=-21mm, xshift=-1cm,anchor=east] at (img1.north west) (Compositor) {Red cursor in Compositor};
        \node [yshift=-26mm, xshift=-1cm,anchor=east] at (img1.north west) (Timeline) {red cursor in Timeline};
        \draw [->, line width=1mm] (Compositor) edge  ([yshift=-21mm] img1.north west);
@@ -116,7 +116,7 @@ Figure~\ref{fig:cursor02} using the \textit{Always show next frame} method where
        \centering
        %\includegraphics[width=0.8\linewidth]{name.ext}
        \begin{tikzpicture}[scale=1, transform shape]
-       \node (img1) [yshift=0cm, xshift=0cm, rotate=0] {\includegraphics[width=0.6\linewidth]{images/cursor02.png}};    
+       \node (img1) [yshift=0cm, xshift=0cm, rotate=0] {\includegraphics[width=0.6\linewidth]{cursor02.png}};    
        \node [yshift=-23mm, xshift=-1cm,anchor=east] at (img1.north west) (Compositor) {White cursor in Compositor};
        \node [yshift=-28mm, xshift=-1cm,anchor=east] at (img1.north west) (Timeline) {White cursor in Timeline};
        \draw [->, line width=1mm] (Compositor) edge  ([yshift=-23mm] img1.north west);
@@ -142,7 +142,7 @@ The cause of the issue is that X11 is RGB only and it is used to draw the \texti
 \begin{wrapfigure}[11]{O}{0.5\textwidth} 
     \vspace{-5ex}
     \centering
-    \includegraphics[width=0.5\textwidth,keepaspectratio]{images/color.png}
+    \includegraphics[width=0.5\textwidth,keepaspectratio]{color.png}
     \caption{Color space and Color range}
     \label{fig:color}
 \end{wrapfigure} 
@@ -160,16 +160,39 @@ There is now program code to look for RGB versus YUV color model mismatches.  Yo
     \item[YUV color range] default choice is JPEG,   alternate is MPEG
 \end{description}
 
+\section{Automatic "Best Model" Media Load}%
+\label{sec:conform_the_project}
+When you load media with the insertion strategy of \textit{replace current project}, the program code will
+automatically use the "best model" for the render based on the media's codec.  The best model is pretty
+much going to be what works well for television.  This automation was added to facilitate easy use of
+\CGG{}.  Which is to say that it is difficult for a new or occasional user to set all of the 
+necessary parameters as best as possible so the program does it for you.  This means you do not have to 
+\textit{conform your project} which ordinarily would have to have been done in the Resources window with RMB
+click on the highlighted media and choosing \textit{Match project size}. 
+
+However, this automatic method leads to the dilemma of where you have a 10-bit media file and it would
+get loaded as RGBA-8 when you would prefer it to be RGBA-Float.  So instead of using \textit{replace current
+project} when loading your media, you would have to make sure the project is first set to your desired
+Format.  This could be done with the File$\rightarrow$New project and then setting your Color
+Model to RGBA-Float and whatever other parameters you want.  Next when doing a File$\rightarrow$Load, use
+\textit{Append in new tracks} or \textit{Create resources only}. This avoids using the "best model"
+technique and uses instead what you have designated so that if you set the Color Model to RGBA-Float that
+will be in effect.
+
+It is important to note that even when using the "best model" no bits are lost if the input media is 10-bit
+and the Color Model is RGBA-8. This is because the media will be loaded using the "case BC\_RGB16161616"
+where 16 stands for 16 bits. It fills the other 6 bits not used for 10 bits with zeros.
+
 \section{Simple Animation (Festival)}%
 \label{sec:simple_animation_festival}
 
-This functionality was added to Cinelerra by the original author to create simple animation.  The file type for this animation is \textit{Scene}.
+This functionality was added to \CGG{} by the original author to create simple animation.  The file type for this animation is \textit{Scene}.
 
 To get started making a simple animated movie copy from the directory:\\
 \texttt{<cin\_path>/cinelerra/tests} the \texttt{text2movie} and \texttt{text2movie.xml}. \\
 You can see what this does via \texttt{File $\rightarrow$ Load\dots $\rightarrow$ text2movie.xml}.  The file text2movie acts like a normal asset, except changes to it are immediately reflected on the timeline without reloading and the length is infinite.  You can just edit the text2movie file to change the script.  If the length of the movie increases, drag the right edit handle to extend the edit or use the pulldown \texttt{Edit $\rightarrow$ edit length}. There is one audio channel created for every character.  The frame rate, sample rate, frame size, and camera angles are fixed.  To see these values, right click on the asset and look at the \textit{Asset info}.
 
-Currently the functionality that is implemented focuses on dialog between two people.  The models are defined in model files saved in Cinelerra's executable directory (for example, \texttt{/opt/cinelerra/models}).  The character model and voice is selected separately in the script.  The model files have the same name that appears in the script and are usually saved in the directory the script is in, but there is a defined search path, if not.  You can create new models for the script without affecting the entire system.  These models define the total size of the model along with the images used -- the model images are 2D png images because all the animations are baked.  Since there is no 3D renderer, no custom movement is supported.
+Currently the functionality that is implemented focuses on dialog between two people.  The models are defined in model files saved in \CGG{}'s executable directory (for example, \texttt{/opt/cinelerra/models}).  The character model and voice is selected separately in the script.  The model files have the same name that appears in the script and are usually saved in the directory the script is in, but there is a defined search path, if not.  You can create new models for the script without affecting the entire system.  These models define the total size of the model along with the images used -- the model images are 2D png images because all the animations are baked.  Since there is no 3D renderer, no custom movement is supported.
 
 There are currently 2 actions implemented: