add missing Viewer audio file usage
[goodguy/cin-manual-latex.git] / parts / Windows.tex
index 06ca4eae522a910d2c1a551a607a323f149be4fe..baa495aeae238a24fa3e17d4965e0b22ecee6505 100644 (file)
@@ -9,6 +9,11 @@
     \label{fig:Fenstergrundposition-en}
 \end{figure}
 
+First it is important to know what an EDL is. When \CGG{} saves a file, it saves the EDL,
+Edit Decision List, of your project which contains all the settings and locations of edits
+and pointers to the media so that the media is not modified. The EDL is described in the
+Load, Save and the EDL chapter (\ref{sec:edl_edit_decision_list}).
+
 \section{Program Window}%
 \label{sec:program_window}
 
@@ -16,7 +21,7 @@ The main window is called the \textit{Program} window and is often just referred
 This timeline consists of a vertical stack of tracks with time represented horizontally on the track. 
 It is the output of the rendering operations and this is what is saved when you run the File pulldown, Save command.
 Immediately to the left of the timeline is the patchbay. The patchbay contains options that affect each track.  
-These options are described in great detail in the Editing section (\ref{sec:patchbay}).
+These options are described in great detail in the Editing chapter (\ref{sec:patchbay}).
 
 The \textit{Window} pulldown on the main window contains options
 that affect the 4 main windows. The first 3 options are used to
@@ -202,7 +207,7 @@ on the timeline operate.
 There is:  \emph{drag and drop mode} and \emph{cut and paste mode}. 
 The editing mode is determined by selecting the \texttt{arrow}, or immediately to the right of the arrow,
 the \texttt{I-beam} in the Transport and Buttons bar. In figure~\ref{fig:insertion-points} you can see
-the green colored highlight on the arrow icon indicating that you are currently in 
+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. 
@@ -751,7 +756,7 @@ screens, zooms, and pans in the compositor.
 
 The \textit{Output size} can be set in \texttt{File $\rightarrow$ New} when creating a new project,
 or by using \texttt{Settings $\rightarrow$ Format}, or in the Resources window with RMB click on
-a video asset and choosing \emph{Match project size}. When you \emph{Match project size}, you
+a video asset and choosing \texttt{Match $\rightarrow$ Match project size}. When you \emph{Match project size}, you
 are conforming the output to the asset. Once you have set the output size in 1 of these 3 ways,
 any newly created tracks will conform to the specified output size.  When rendering, the project's
 output size is the final video track size where the temporary pipeline is rendered into.  
@@ -821,7 +826,7 @@ green and yellow colored outlines.
 placement.
 \end{enumerate}
 
-When you drag over the viewport in the compositor window, it looks like you are moving the camere
+When you drag over the viewport in the compositor window, it looks like you are moving the camera
 with the mouse.  The viewport moves in the same manner.
 
 \subsubsection*{Camera Compositing}%
@@ -850,7 +855,7 @@ By either tumbling or entering text directly, the camera and projector can be pr
 Justification types are also defined for easy access. 
 A popular justification operation is upper left projection after image reduction. 
 This is used when reducing the size of video with aspect ratio adjustment.  
-In the last figure you see the choices for justification as the red stripe in the 6 boxes in the order of left, center horizontal, right, top, center vertical, and bottom.
+In the last figure you see the choices for justification as the location of the line in the 6 boxes in the order of left, center horizontal, right, top, center vertical, and bottom.
 
 The translation effect allows simultaneous aspect ratio conversion and reduction but is easier to use if the reduced video is put in the upper left of the \textit{temporary} instead of in the center. 
 The track size is set to the original size of the video and the camera is centered. 
@@ -875,9 +880,9 @@ In the compositing window, there is a popup menu of options for the camera and p
 \label{ssub:use_case_interaction_camera_projector}
 
 \begin{enumerate}
-    \item Start by shrinking the projector to $z=0,500$ ($\frac{1}{4}$ of the original frame).
-    \item The next step is to switch to the camera and note that the green box has assumed the size of the projector, i.e.\ the red box. The value of $z$ of the camera is always equal to $1,000$ (default) but the frame is $\frac{1}{4}$ of the original frame, i.e.\ it has the size of the projector that has $z=0,500$. This is the current viewport size.
-    \item You enlarge the room bringing $z=2,000$. You can see that the dimensions of the viewport (green box) do not change, remaining the same as those of the projector. However, the frame has been enlarged and this variation is indicated by the enlargement of the yellow box. Let's remember that this follows the changes made with the camera tool.
+    \item Start by shrinking the projector to $z=0.500$ ($\frac{1}{4}$ of the original frame).
+    \item The next step is to switch to the camera and note that the green box has assumed the size of the projector, i.e.\ the red box. The value of $z$ of the camera is always equal to $1.000$ (default) but the frame is $\frac{1}{4}$ of the original frame, i.e.\ it has the size of the projector that has $z=0.500$. This is the current viewport size.
+    \item You enlarge the room bringing $z=2.000$. You can see that the dimensions of the viewport (green box) do not change, remaining the same as those of the projector. However, the frame has been enlarged and this variation is indicated by the enlargement of the yellow box. Let's remember that this follows the changes made with the camera tool.
     \item We can drag the room so that we can center the frame to our liking. The movement of the yellow box shows well the variation compared to the green box.
     \item Finally, if we want, we can switch to the projector tool to move the output frame to the position we want with respect to the size of the source. Of course, we can also work on the $z$, which in the example is at $z=0.500$, if we have decided to change the size of the output.
 \end{enumerate}
@@ -927,10 +932,12 @@ that you are viewing in the compositor.  An easy way to see the masked area is t
 below the target track and drag the \textit{Gradient} plugin to a highlighted area on that track.
      \item  You can move existing points to new locations by simply using the LMB at a point to
 drag that point to a different location.
-    \item  The mask can be translated as a single entity by Alt-dragging the mask.
+    \item  The mask can be translated as a single entity by Alt-dragging the mask.  For some desktop
+window managers, such as \textit{UbuntuStudio 16.4} and \textit{Arch}, the Alt key is already in use
+by the Operating System so you will have to use Alt+Ctrl instead.
     \item To create curved instead of straight lines between the points, use  Ctrl-drag on a
 specific point. Using Ctrl-drag activates bezier handles (control points) to create these curves
-between the points.       
+between the points. For example, on a mask with just two points, you can create a romantic heart mask.     
 \end{enumerate}
 
 There are a lot more operations you can do using the Mask menu as shown in 
@@ -974,7 +981,9 @@ When you click \textit{Load} preset, keep in mind that it will write the mask nu
 
 \textit{Center} mask button allows for quickly centering a mask on the video track. 
 \textit{Normalize} mask button makes it easy to normalize the size of the mask based on the scale of the video. 
-The next 3 symbols concern the direction to \textit{drag translate} a mask using the \texttt{Alt+LMB} thus making it easy to preserve the current $X$ or $Y$ value when desirable.
+The next 3 symbols concern the direction to \textit{drag translate} a mask using the \texttt{Alt+LMB} thus making it easy to preserve the current $X$ or $Y$ value when desirable.  For some desktop window managers,
+such as \textit{UbuntuStudio 16.4} and \textit{Arch}, the Alt key is already in use by the Operating System
+so you will have to use Alt+Ctrl instead.
 
 \texttt{xlate/scale x} - drag translate constrained in the $X$ direction
 
@@ -987,7 +996,7 @@ The next 3 symbols concern the direction to \textit{drag translate} a mask using
 
 The \texttt{Fade}: textbox is used to type in a fade value; the tumbler to the right of the textbox allows you to increase or decrease that number; and the slider bar makes it quick to adjust the fade value.  The fader goes from $-100$ on the left to $+100$ on the right for negative to positive.  Default value is $+100$. The fade slider includes a sticky point at 0 so that it is easy to get to 0 without going too far or not quite far enough -- that way you don’t have to keep jiggling to get there. 
 
-In addition there is a \textit{Gang fader} symbol to allow for having all of the masks fade in unison. The symbol is surrounded by a gold colored background when it is in effect.  If you have multiple masks with different modes, a decision had to be made on what value to use -- it uses the maximum transparency value of the background to determine the operations results.  To understand how this works, here is a summary:
+In addition there is a \textit{Gang fader} symbol to allow for having all of the masks fade in unison. The symbol is surrounded by a green colored background \protect\footnote{green is used in the default Cakewalk theme, but the background color will be different in other themes} when it is in effect.  If you have multiple masks with different modes, a decision had to be made on what value to use -- it uses the maximum transparency value of the background to determine the operations results.  To understand how this works, here is a summary:
 
 Note1: The area outside the mask is referred to as the background.
 
@@ -1206,6 +1215,26 @@ accidentally closed you can open it again by using the pulldown \texttt{Window $
 Viewer} to bring it back up.  More details for editing in the Viewer window with the Two Screen
 Editing method is explained in~\ref{sec:two_screen_editing}.
 
+
+\begin{figure}[htpb]
+    \centering
+    \includegraphics[width=1.0\linewidth]{viewer_audio.png}
+    \caption{Viewer window at the top displaying same 5 seconds as seen in the Resources window thumbnail. At the bottom of the screen is the audio loaded on the timeline.}
+    \label{fig:vieweraudio}
+\end{figure}
+
+You can also use the Viewer to listen to media that consists only of Audio.  This is a quick way
+to listen to the audio to see if it is what you would like to add to a timeline audio track for
+your project.  To do this, you simply drag the audio file from the Resources window in the same
+manner as a video file. The viewer was designed to "view" images rather than play audio so in order
+to make it obvious that audio media is loaded to the viewer, a waveform is displayed that is the
+same waveform as shown in the Resources window thumbnail when in the \textit{Display Icons} mode.
+This waveform only represents the first 5 seconds of the media and will not change or move while
+playing in the Viewer window.  But you can play the entire piece of media in the window
+and as you do so, you see the play cursor line move along and the timestamp reflect the actual
+position of the audio. The entire waveform can only be seen on an actual audio track on the
+timeline. An example of what this looks like is shown in figure~\ref{fig:vieweraudio}.
+
 \section{Options in both the Compositor and Viewer Windows}%
 \label{sec:options_in_both_the_compositor_and_viewer_windows}
 
@@ -1216,8 +1245,8 @@ The next sections describe capabilities that are available in both the Composito
 
 In both the Viewer and Compositor windows, there is an arrow on the right hand side of the other
 buttons in the edit panel as shown in figure~\ref{fig:viewer_window}.  The "play" button can be
-toggled on/off via this arrow, which has a tooltip of \textit{Click to play}.  When enabled there
-is a green or gold colored shadow around the usual red or green colored arrow.
+toggled on/off via this arrow, which has a tooltip of \textit{Click to play}.  When enabled
+the arrow is white surrounded by green and when disabled the arrow is red.\protect\footnote{the color and the look will be different for themes other than the default theme of Cakewalk}
 The purpose of enabling this capability is to make it really easy to play the media in the window
 by just using the left mouse button to start or stop the play.  The entire main canvas surface
 becomes a big play button!  Although the default is initially off, a good reason to enable this,
@@ -1353,8 +1382,8 @@ Other options you will see if you \textit{right mouse click in the folder} which
         contents highlighted for ease of use so you can see what is or is not loaded, or unset the highlight.
     \item[Sort items]  to sort the contents of the folder alphabetically.  Especially helpful if you accidentally did a 
         drag and changed your mind or dropped suddenly so that the assets no longer look nicely aligned.
-    \item[Copy/Paste file list]  use to easily copy a set of files or paste a set of files between Cin and windows.
-    \item[Snapshot/Grabshot]  described elsewhere in more detail.
+    \item[Copy/Paste file list]  use to easily copy a set of files or paste a set of files between \CGG{} and other programs or operating system windows.
+    \item[Snapshot/Grabshot]  use to take a quick snapshot or to grab a specific area on the screen.  These functions are described in detail in section \ref{sub:snapshot_grabshot}).
 \end{description}
 
 Using the right mouse click to bring up a menu in the folder area, you can also switch from Display text to Display icons, Sort items and create, delete and manipulate user defined folders/bins. Select Folder to create a user Folder or modify an existing folder.
@@ -1889,7 +1918,6 @@ If normally audio is included in the play, it will be removed and if normally au
 The compositor has zoom capability. 
 The pull-down menu on the bottom of the compositor window has a number of zoom options. 
 When set to Auto the video is zoomed to match the compositor window size as closely as possible. 
-When set to any other percentage, the video is zoomed a power of 2 and scrollbars can be used to scroll around the output. 
 When the video is zoomed bigger than the window size,  you can use scrollbars to scan around or if the zoom icon is enabled, the middle mouse button can be used to zoom in or out the video.
 
 The zoom toggle also causes the Compositor window to enter zoom mode. 
@@ -1905,7 +1933,7 @@ This could affect performance on slower systems
 Color Coded Keyframe Curves are a big feature in the \textit{Show Overlays} window because by changing the colors to suit the user, it helps to remove confusion from multiple curves on the track canvas.  
 They can be viewed from the pulldown menu of \texttt{Window $\rightarrow$ Show overlays} but they will operate the same as when used from the View pulldown menu.  
 The \textit{Color Coded Keyframe Curves} have distinct colors associated with each type for ease of identification.  
-By clicking button 1 on the \textit{Color Ball} to the right of any keyframe type in the \textit{Show overlays} menu you have the ability to change the colors to whatever works best for your video.  
+By clicking LMB on the \textit{Color Ball} to the right of any keyframe type in the \textit{Show overlays} menu you have the ability to change the colors to whatever works best for your video.  
 The color ball changes made will be retained across sessions.
 
 There is a line separating the first 4 items, which are just non-automation type settable values as opposed to \textit{auto} keyframe types.