MatN and Andrea reviewed changes
[goodguy/cin-manual-latex.git] / parts / Windows.tex
index 8bd6808f58ad67575afd6b621a9f6be8a5301182..474f3afcd34a8e3a1a31a154a042f4d9148fbc20 100644 (file)
@@ -1,4 +1,4 @@
-\chapter{The 4+ Windows}%
+\chapter{Interface (the 4+ Windows)}%
 \label{cha:the_4_windows}
 
 \begin{figure}[htpb]
@@ -11,8 +11,7 @@
 
 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}).
+and pointers to the media so that the media is not modified. The EDL is described in \nameref{sec:edl_edit_decision_list}.
 
 \section{Program Window}%
 \label{sec:program_window}
@@ -21,7 +20,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 chapter (\ref{sec:patchbay}).
+These options are described in great detail in \nameref{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
@@ -33,7 +32,7 @@ displays, the \textit{Default positions} operation only uses the one
 monitor to display the windows, but as you can see in the
 \textit{Window} pulldown you have more options to change that. Usage
 with dual monitors is explained
-in~\ref{sec:multiscreen_playback_configuration}.
+in~\nameref{sec:playback_a_b}.
 
 \subsection{Video and Audio Tracks and Navigation}%
 \label{sub:video_and_audio_tracks_and_navigation}
@@ -59,14 +58,14 @@ 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.  
 
 Once you have become familiar with many of the graphical tools and pulldowns, you can switch to using more of
 the keyboard to navigate.  Many of the key equivalences are listed in each of the pulldowns to the right of the option
  as a shortcut. All of the shortcuts are listed in a document for keyboard 
-navigation (\ref{sub:main_menu_keys}). This includes, for example, shortcuts like the \texttt{Home} and \texttt{End} keys to go to the beginning or end of the timeline.  
+navigation (\nameref{cha:shortcuts}). This includes, for example, shortcuts like the \texttt{Home} and \texttt{End} keys to go to the beginning or end of the timeline.  
 Another example is in the default cut and paste mode, hold down \texttt{Shift} while pressing \texttt{Home} or \texttt{End} in order to select the region of the timeline between the insertion point and the key pressed.
 
 \subsection{Zoom Panel}%
@@ -82,7 +81,8 @@ Then more details are provided in the next paragraphs.
    \hline
        Sample zoom & Duration visible on the timeline \\
        Amplitude & Audio waveform scale \\
-       Track zoom & Height of tracks in the timeline \\
+       Track audio zoom & Height of audio tracks \\
+       Track video zoom & Height of video tracks \\
          (type) & Automation Type \\
        Curve zoom & Automation range minimum and maximum \\
        Selection change & 3 boxes with starting point, length, and ending point \\
@@ -99,10 +99,10 @@ You can either use the $\uparrow$ and $\downarrow$ arrows to change the sample z
 
 The next option is \emph{amplitude} and it only affects the audio waveform size. \texttt{Ctrl-$\uparrow$} and \texttt{Ctrl-$\downarrow$} are shortcuts used to change the amplitude zoom as an alternative to the down arrow to the right of the numerical size.
 
-The \emph{track zoom} affects all tracks and determines the height of each track. 
-If you change the track zoom, the amplitude zoom will be changed also so that the audio waveforms
+The \emph{track audio and video zoom} affects all tracks of that type and determines the height of each track. 
+If you change the audio track zoom, the amplitude zoom will be changed also so that the audio waveforms
 are proportionally sized.
-Shortcuts, \texttt{Ctrl-Pgup} and \texttt{Ctrl-Pgdown}, change the track zoom.
+Shortcuts, \texttt{Ctrl-Pgup} and \texttt{Ctrl-Pgdown}, change the track zoom to the next level simultaneously for all of the audio and video tracks.
 
 \emph{Automation type} is used for selecting one of the following: Audio Fade, Video Fade, Zoom, Speed, X, or Y (X and Y are for the compositor's Camera and Projector).  When an auto line is present on
 the timeline and is being manipulated, a small square the same color as the line will be shown to 
@@ -151,6 +151,8 @@ The Track Menu contains a number of options:
         media. In Drag and Drop editing mode, if you select multiple edits all of those clips will have
 their title name changed.
     \item[Bar color]  allows the user to select a specific color for the title bar.  This helps to more easily locate a piece of media.
+    \item[Swap up] moves the selected track one step up in the stack of its corresponding type - audio or video.
+    \item[Swap down]  moves the selected track one step down in the stack of its corresponding type - audio or video.
     \item[Resize Track]  resizes the track; this is only applicable to video tracks.
     \item[Match Output Size]  resizes the track to match the current output size; this is only applicable to video tracks.
 \end{description}
@@ -210,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
@@ -238,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.
 
@@ -252,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. 
@@ -404,9 +405,12 @@ The main window pulldowns as pointed out in figure~\ref{fig:insertion-points} ar
     \item[File]  options for loading, saving, and rendering as described in other sections (\ref{cha:load_save_and_the_EDL}).
     \item[Edit]  edit functions; most of which have shortcuts that you will quickly learn (\ref{cha:editing}).
     \item[Keyframes]  keyframe options which are described in the Keyframe section (\ref{cha:keyframes}).
-    \item[Audio]  audio functions such as \textit{Add track}, \textit{Attach transition/effect}.
+    \item[Audio]  audio functions such as \textit{Add track}, \textit{Attach effect}
+and \textit{Attach transition}.  The \textit{Attach effect} is especially useful when
+you need the effect to be applied to all related audio tracks as a \textit{Shared effect}
+and is described as an alternative method of application in section \ref{sec:shared_effect_tracks}.
     \item[Video]  video functions such as \textit{Add track, Default/Attach transition, Render effect}.
-    \item[Tracks]  move or delete tracks are the most often used.
+    \item[Tracks]  move or delete tracks are the most often used plus \textit{Align Timecodes}.
     \item[Settings]  much of this is described elsewhere with the most frequently used to include
 Preferences (\ref{cha:configuration_settings_preferences}), Format (\ref{cha:project_and_media_attributes}), 
 Proxy and Transcode (\ref{sec:proxy_settings}), as well as the others.
@@ -448,6 +452,21 @@ To use the desired layout, keyin the shortcut or use the Window pulldown and cho
 layouts because they can be executed from any of the 4 windows instead of just the main
 timeline window.
 
+\subsection{Multi-Pane Support}%
+\label{sub:multipane_support}
+
+The main \CGG{} edit window holds the Track Canvas which can be divided into 4 panes of track data: 1 or 2 vertical panes and/or 1 or 2 horizontal panes.  To split the track, use the Window pulldown, and then click on \textit{Split X} or \textit{Split Y} depending on how you wish to split the track.  Alternatively, the canvas pane types can be changed using keys \textit{<Ctrl-1>} for toggle split horizontal or \textit{<Ctrl-2>} for toggle split vertical.  Or the track can be split into panes by using the \textit{+ widget} in the lower right hand corner of the track canvas.  Once the track has been divided, you can use the + widget shortcut or the drag bars to change the size of the panes.
+
+Multi-Pane, or split screen, allows you to look at the first part of a movie at the same time as a part that is a long ways away on the timeline which would have been off the screen.  By having multiple panes, you can see the 2 parts you want to look at simultaneously and drag/drop easily between the 2.  Also, the \textit{X pane split} is extremely convenient for laptop users and computer monitors with small screens since it can be used with horizontal scrolling with the mouse wheel + Ctrl.  The \textit{Y-pane split} makes it easy to see 2 simultaneous drag and drop zones when you have lots of tracks (figure~\ref{fig:multi-pane01}).
+
+\begin{figure}[htpb]
+       \centering
+       \includegraphics[width=1.0\linewidth]{multi-pane01.png}
+       \caption{Shown are 4 panes that have split in X and Y the main track canvas}
+       \label{fig:multi-pane01}
+\end{figure}
+
+
 \subsection{Just Playing!}%
 \label{sub:just_playing_}
 What if you are just using \CGG{} to play media and listen to tunes? 
@@ -746,20 +765,52 @@ cropped.
 \subsubsection*{Track and Output size}%
 \label{ssub:track_size}
 
-The \textit{Track size} is used to define the temporary size with each track having a different size.
+The \textit{Track size} is used to define the temporary size with each track having a different size (viewports). It also serves to conform the input media to a chosen format (aspect ratio). So each track can have a different format (viewport).
 You can see or set the track size by RMB click on a track and then select \emph{Resize Track} to resize
 the track to any size. Or select \emph{Match output size} to make the track the same size as the
-output.  When a track is resized what it looks like on the compositor changes.  The relationship
+output. Or from the Resources window, RMB on a video media and choose \textit{Info} and then \textit{Resize}. When a track is resized what it looks like on the compositor changes.  The relationship
 between the track and the project's output size makes it possible to magnify or reduce the size of
-a track in regards to the final output. This feature means you cancreate visual effects such as split
-screens, zooms, and pans in the compositor.
+a track in regards to the final output. This feature means you can create visual effects such as different aspect ratios, adjust split 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 \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,
+are conforming the output to the asset. To change the size and aspect ratio of the output (Projector) we have to change the whole project, which will alter all the tracks in the timeline. 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.  
+output size is the final video track size where the temporary pipeline is rendered into. 
+
+\subsubsection*{Aspect Ratio (Theory)}%
+\label{ssub:aspect_ratio_theory}
+
+The aspect ratio is the ratio of the sides of the frame (\textit{Width} and \textit{Height}). For example, classically broadcast TV was 4:3 (= 1.33), whereas today it has changed to 16:9 (= 1.85); in cinema we use the 35 mm aspect ratio of 1.37 (Academic aperture), but even more so the super 35 mm (2.35). There are also anamorphic formats, i.e. that have no square pixels, like Cinemascope (2.35). The projection must be \textit{normalized} to have an undistorted view.
+
+
+From the film or digital sensors of the cameras, we can extract any frame size we want. We are talking about \textit{viewports}, which we will examine shortly. Also important is the output of the film that will be rendered, because it is what we will see at the cinema, or on TV, or on the monitor of the PC, tablet or smartphone. Referring to figure~\ref{fig:temporary-01}, you can see these two possibilities: with the Camera you choose the size and aspect ratio of the source file (regardless of the original size); while with the Projector you choose the size and aspect ratio of the output.
+
+The following formula is used to vary the aspect ratio:
+
+\qquad $\frac{W}{H} =$ aspect ratio ($\frac{pixels}{pixels}$)
+
+For example to obtain an aspect ratio of Super 35 mmm (2.35) starting from a FullHD file (1920x1080) whose base extension (1920) we want to keep:
+
+\qquad $\frac{1920}{H} = 2.35$
+
+from which: $H = 817$ pixels
+
+\CGG{} allows you to vary the input and output aspect ratio in the ways indicated in the previous section: by varying the pixels of the sides or by setting a multiplication coefficient.
+
+In \texttt{Settings $\rightarrow$ Format} there is the additional possibility to vary the shape of the pixels from 1:1 (square) to handle anamorphic formats. In such cases we use:
+
+\qquad $PAR=\frac{DAR}{SAR}$
+
+where:
+
+\textit{DAR}= Display Aspect Ratio
+
+\textit{PAR}= Pixel Aspect Ratio (1 or 1:1 is square)
+
+\textit{SAR}= Storage Aspect Ratio (i.e media file aspect ratio)
+
 
 \subsection{Camera and Projector}%
 \label{sub:camera_and_projector}
@@ -810,13 +861,7 @@ and the size of the frame. After you position the video with the projector, you
 \subsubsection*{The Viewport}%
 \label{ssub:viewport}
 
-The \textit{viewport} is a window on the camera that frames the area of source video. The size of
-the current track is used for the initial size of the viewport. A smaller viewport, for example
-($640\times480$), captures a smaller area; whereas a larger viewport of ($800\times600$) captures
-a larger area.  If the captured area is larger than the source video, the empty spaces will be
-automatically filled with blanks.  After the viewport is defined, the camera needs to be placed
-right above the area of interest in the source video. Operations to control the location of the
-camera are as follows:
+The \textit{viewport} is a window on the camera that frames the area of source video. The size of the current track is used for the initial size of the viewport. A smaller viewport, for example ($640\times480$), captures a smaller area; whereas a larger viewport of ($800\times600$) captures a larger area.  If the captured area is larger than the source video, the empty spaces will be automatically filled with blanks.  To change the size and aspect ratio of the viewport (Camera) of a single track, right-click on the track in the timeline and choose Resize Track. Here we can vary the height and base of the viewport in pixels or choose the multiplication coefficient for each side (Scale). With OK we will see the change in the Compositor window with the new dimensions reflected in the green box. We can have different size viewports for each video track on the timeline. To go back, reset the viewport to the original value. After the viewport is defined, the camera needs to be placed right above the area of interest in the source video. Operations to control the location of the camera are as follows:
 
 \begin{enumerate}
     \item  In the compositor window you should see the selected track.
@@ -844,7 +889,7 @@ These are accessed in the \emph{Show tool info} window.
 Most operations in the Compositor window have a tool window which is enabled by activating the question mark icon (figure~\ref{fig:camera_tool}).
 
 \begin{wrapfigure}[10]{O}{0.45\linewidth} 
-       \vspace{1ex}
+       %\vspace{1ex}
     \includegraphics[width=1.0\linewidth]{camera_tool.png}
     \caption{Camera and Projector tool}
     \label{fig:camera_tool}
@@ -867,6 +912,18 @@ To put the reduced video in the center subsection that the projector shows would
 Instead, we leave out $x$ and out $y$ at 0 and use the projector's tool window. 
 By selecting left justify and top justify, the projector displays the reduced image from the top left corner of the \textit{temporary} in the center of the output.
 
+Other buttons cover the 5 modes of curves interpolation: smooth, linear, tangent, free, bump.
+
+\begin{description}
+       \item[smooth:] bezier interpolation which are flat at the endpts
+       \item[linear:] piecewise linear curve.
+       \item[tangent:] bezier interpolation with collinear endpts in a specified line.
+       \item[disjoint:] piecewise bezier, if there is such a thing.
+       \item[bump:] has 2 values, one viewed from the left/right, discontinuous.
+\end{description}
+
+Finally there are the 2 buttons for the bump curves: settings on Right/Left Edges and Span (see \nameref{sec:bump_autos}).
+
 \subsubsection*{Reset to Default}%
 \label{ssub:reset_default}
 
@@ -1215,6 +1272,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. You can also create clips. 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}
 
@@ -1400,6 +1477,12 @@ For Clips, \emph{Nest} and \emph{UnNest} as described elsewhere are available.
 The asset \emph{Info} window also can be used to display detailed information about the selected/highlighted media file -- available for any loaded media of type mpeg or ffmpeg.  
 This is extremely helpful in determining what type of media it is, size, resolution, format, and type/number of audio streams.  It is especially useful for multiple program streams.  You can have the info window popped on several of your assets simultaneously.
 
+\textit{Detail} opens an additional window with more information.
+
+\textit{Sample rate} and \textit{Frame rate} allows you to impose a different sampling or Fps of the audio and video assets.
+
+Another option is \textit{Resize} button, which allows you to change the sides (in pixels) of the frame of the asset.
+
 \textit{Asset's interlacing}  is the type of interlacing the asset has: If the file is (H)DV type, recognition and configuration is done automatically. All other media types will be set unknown. So we have to manually set the interlacing \protect\footnote{From Igor ubuntu's mail}.
 
 Figure~\ref{fig:info_asset_details} shows the \textit{Detail} box to click on the left side and a simple, typical output in the Asset Detail window on the right side.  Also, note the highlighted media in the Resources window.
@@ -1407,7 +1490,7 @@ Figure~\ref{fig:info_asset_details} shows the \textit{Detail} box to click on th
 \begin{figure}[htpb]
     \centering
     \includegraphics[width=0.99\linewidth]{info_asset_details.png}
-    \caption{The “Detail” box}
+    \caption{Info windows with the “Detail” box}
     \label{fig:info_asset_details}
 \end{figure}
 
@@ -1415,7 +1498,8 @@ Figure~\ref{fig:info_asset_details} shows the \textit{Detail} box to click on th
 \label{sub:user_folders_bins}
 
 Creating folders that are more specific to a particular project is helpful in better organizing your work.  
-This can be done by utilizing the files already loaded to the \textit{master} Media or Clips folders in the Resources window.  
+This can be done by utilizing the files already loaded to the \textit{master} Media or Clips folders in the Resources window.  The general rule is you can only drag clips to a ClipUserBin and you can only drag media to a MediaUserBin.
+
 Below are steps illustrating an easy way to set up a folder.
 
 %TODO Below part need to be rewriten
@@ -1995,6 +2079,14 @@ An additional window, the levels window, can be brought up from the Window pulld
 The levels window displays the output audio levels after all mixing is done.  
 The visible range of the sound level meters is configurable in \texttt{Settings $\rightarrow$ Preferences, Interface tab} under the Operations section.
 
+\begin{wrapfigure}[18]{O}{0.3\linewidth} 
+       \centering
+       \vspace{-2ex}
+       \includegraphics[width=0.5\linewidth]{volume_meter.png}
+       \caption{Sound Level Meters Window}
+       \label{fig:volume_meter}
+\end{wrapfigure}
+
 Sound level meters can be toggled in the viewer and compositor windows with the show meters button.  
 They also appear in the patchbay when the track is expanded and in the recording monitor when audio is being recorded. 
 
@@ -2003,14 +2095,6 @@ In the record monitor they are the input values from the sound card.
 In the patchbay they are the sound levels for each track after all effects are processed and before down-mixing for the output.  
 Most of the time, audio levels have numerical markings in dB but in the patchbay there is not enough room.
 
-\begin{wrapfigure}[15]{O}{0.3\linewidth} 
-       \centering
-       \vspace{-4ex}
-       \includegraphics[width=0.5\linewidth]{volume_meter.png}
-       \caption{Sound Level Meters Window}
-       \label{fig:volume_meter}
-\end{wrapfigure}
-
 The sound level is color coded as an extra means of determining the sound level.  
 Even without numerical markings, the sound level color can distinguish between several ranges and overload.  
 Look at the color codings in a meter with numerical markings to see what colors correspond to what sound level.