Stop at Viewer Window
[goodguy/cin-manual-latex.git] / parts / Windows.tex
index 03f524657098da32ebc93cc8da82968ae84794b5..9785510ab098a9e9a603d5bc1e81995c6e2598cf 100644 (file)
@@ -174,7 +174,7 @@ Dragging in the timeline highlights a region.
 The highlighted region becomes the region affected by cut and paste operations and the playback range during the next playback operation. 
 Shift-clicking in the timeline extends the highlighted region.
 
-When highlighting a region, the start and end points are either aligned to frames or aligned to samples. When editing video, you will want to align to frames. When editing audio you will want to align to samples. Select your preference by using settings->align cursor on frames.
+When highlighting a region, the start and end points are either aligned to frames or aligned to samples. When editing video, you will want to align to frames. When editing audio you will want to align to samples. Select your preference by using settings$\rightarrow$align cursor on frames.
 
 \begin{figure}[htpb]
     \centering
@@ -257,7 +257,7 @@ If you hit the label button when a region is highlighted, labels are created at
 However, if one end already has a label, then the existing label is deleted. 
 Hitting the label button again when a label is selected deletes it. 
 Manually hitting the label button or L key over and over again to delete a series of labels can get tedious. 
-To delete a set of labels, first highlight a region, then use the Edit->Clear labels function. 
+To delete a set of labels, first highlight a region, then use the Edit$\rightarrow$Clear labels function. 
 If in/out points exist, the labels between the in/out points are cleared and the highlighted region is ignored.
 
 
@@ -490,7 +490,7 @@ Operations done in the Compositor affect the timeline but do not affect clips.
 
 \begin{figure}[htpb]
     \centering
-    \includegraphics[width=0.8\linewidth]{images/compositor_window.png}
+    \includegraphics[width=0.99\linewidth]{images/compositor_window.png}
     \caption{Upper right side contains navigation tools / bottom bar has manu control functions}
     \label{fig:compositor_window}
 \end{figure}
@@ -522,10 +522,317 @@ On the left of the video output is a toolbar specific to the compositor window.
 \emph{Magnifying glass} --- this tool zooms in and out of the compositor output without resizing the window. If the video output is currently locked to the size of the window, clicking in it with the magnifying glass unlocks it and creates scrollbars for navigation.
 
 \begin{description}
-    \item[ Left clicking] in the video zooms in;
+    \item[Left clicking] in the video zooms in;
     \item[Ctrl clicking] in the video zooms out;
     \item[Rotating the wheel] on a wheel mouse zooms in and out.
 \end{description}
 
-In addition, if you enable the Magnifying glass, a zoom slider for fine-viewing appears below these tools.  It allows you to zoom to most any size. A “zoom slider” will pop-up towards the bottom on the left-hand side of the Compositor when you enable “Zoom view” via the magnifying glass or when you click on the icons for “Adjust camera automation” or “Adjust projector automation”.  This will allow for adjusting the amount of zoom at any level between .01 and 100 based on a logarithmic scale.  When using the zoom slider, the number by which the view is zoomed can be seen in the textbox where the original-also-working % zoom is located.  The zoom slider size is in the form of “times”, such as x 0.82 which indicates that the picture is zoomed to 82/100th of the original size as seen in Settings→Format.  Once you have set the zoom to the desired size, use the vertical and horizontal scroll bars to position the view as needed.
+In addition, if you enable the Magnifying glass, a zoom slider for fine-viewing appears below these tools.  
+It allows you to zoom to most any size. 
+A “zoom slider” will pop-up towards the bottom on the left-hand side of the Compositor when you enable “Zoom view” via the magnifying glass or when you click on the icons for “Adjust camera automation” or “Adjust projector automation”.  
+This will allow for adjusting the amount of zoom at any level between 0.01 and 100 based on a logarithmic scale.  
+When using the zoom slider, the number by which the view is zoomed can be seen in the textbox where the original-also-working \% zoom is located.  
+The zoom slider size is in the form of “times”, such as x 0.82 which indicates that the picture is zoomed to 82/100th of the original size as seen in Settings$\rightarrow$Format.  
+Once you have set the zoom to the desired size, use the vertical and horizontal scroll bars to position the view as needed.
+
+Screencast (figure~\ref{fig:zoom_slider}) shows below at a zoom slider bar with the diamond shaped slider in the middle.  Note 
+that the magnifying glass is  enabled which automatically pops-up the slider.
+
+\begin{figure}[htpb]
+    \centering
+    \includegraphics[width=0.99\linewidth]{images/zoom_slider.png}
+    \caption{A zoom slider bar with the diamond shaped slider in the middle}
+    \label{fig:zoom_slider}
+\end{figure}
+The Format shows a large 5204x3468 video and the box at the arrow shows x 0.82 size.  
+
+\begin{description}
+    \item[Masks tool] this tool brings up the mask editing tool. Enable “Show tool info” to see the options.
+    \item[Camera]  the camera brings up the camera editing tool. Enable “Show tool info” to see options.
+    \item[Projector]  the projector brings up the projector editing tool. Enable “Show tool info” for options.
+    \item[Crop tool]  this tool brings up the cropping tool. “Show tool info” must be enabled to use this tool.
+    \item[Eyedropper]  brings up the eyedropper. The eyedropper detects whatever color is under it and stores it
+        in a temporary area. Enabling the “Show tool info” shows the currently selected color. Click
+        anywhere in the video output to select the color at that point. The eyedropper not only lets you see
+        areas which are clipped, but its value can be applied to many effects. Different effects handle the
+        eyedropper differently.
+    \item[Show tool info]  this tool button works only in conjunction with the other controls on the compositor.
+        Based on what compositing control is active, the toggle button will activate or deactivate the
+        appropriate control dialog box. Controls with dialog boxes are: Edit mask, Camera and Projector
+        automation, Crop control, and Get color.
+    \item[Safe regions tool]  draws the safe regions in the video output. This does not affect the rendered output
+\end{description}
+
+\subsection{Compositing}%
+\label{sub:compositing}
+
+A large amount of Cinelerra's editing is directed towards compositing. 
+Changing the resolution of a show, making a split screen, and fading in and out among other things are all compositing operations in Cinelerra. 
+Cinelerra detects when it is in a compositing operation and plays back through the compositing engine only then. 
+Otherwise, it uses the fastest decoder available in the hardware.
+
+Compositing operations are done on the timeline and in the Compositor window. Shortcuts exist in the Resource window for changing some compositing attributes. 
+Once some video files are on the timeline, the compositor window is a good place to try compositing.
+
+\subsection{Camera and Projector}%
+\label{sub:camera_and_projector}
+
+In the compositor window, two of the more important functions are the adjust camera automation and the adjust projector automation which control operation of the camera and projector. 
+Cinelerra's compositing routines use a "temporary", a frame of video in memory where all graphics processing is performed. 
+Inside Cinelerra's compositing pipeline, the camera determines where in the source video the "temporary" is copied from. 
+The projector determines where in the output the "temporary" is copied to. 
+Each track has a different "temporary" which is defined by the track size. By resizing the tracks you can create split screens, pans, and zooms.
+
+In compositing, each frame can be digitally altered using various options, such as a color correction plugin (figure~\ref{fig:camera_and_projector}). 
+Once the image has been transformed, the finished image is then projected to the compositor thus creating a modified version of the original.
+
+\begin{figure}[htpb]
+    \centering
+    \includegraphics[width=0.8\linewidth]{images/camera_and_projector.png}
+    \caption{Camera and Projector}
+    \label{fig:camera_and_projector}
+\end{figure}
+
+When editing the camera and projector in the compositing window, the first track with record enabled is the track affected. 
+Even if the track is completely transparent, it is still the affected track. 
+If multiple video tracks exist, the easiest way to select one track for editing is to Shift-click on the record icon of the track. 
+This solos the track.
+
+The purpose of the projector is to place the contents of the "temporary" into the project's output. 
+The intent of the projector is to composite several sources from the various tracks into one final output track. 
+The projector alignment frame is identical to the camera's viewport, except that it guides where on the output canvas to put the contents of each temporary.
+
+\subsubsection*{Compositing projector controls}%
+\label{ssub:compositing_projector_controls}
+
+When the projector button is enabled in the compositor window, you are in projector editing mode. 
+A guide box appears in the video window. 
+Dragging anywhere in the video window causes the guide box to move along with the video. 
+Shift-dragging anywhere in the video window causes the guide box to shrink and grow along with the video. Once you have positioned the video with the projector, you may want to work with adjusting the camera automation.
+
+\subsubsection*{Compositing camera controls}%
+\label{ssub:compositing_camera_controls}
+
+Select the camera button to enable camera editing mode. 
+In this mode, the guide box shows where the camera position is in relation to past and future camera positions but not where it is in relation to the source video. 
+Dragging the camera box in the compositor window does not move the box but instead moves the location of the video inside the box. 
+The viewport is a window on the camera that frames the area of source video to be scanned. 
+The viewport is represented as a red frame with diagonal cross bars.
+
+\subsubsection*{Viewport sizes}%
+\label{ssub:viewport_sizes}
+
+The size of the viewport is defined by the size of the current track. 
+A smaller viewport (640x400) captures a smaller area. 
+A larger viewport (800x200) captures an area larger than the source video and fills the empty spaces with blanks. 
+Once we have our viewport defined, we still need to place the camera right above the area of source video we are interested on. To control the location of the camera:
+
+\begin{enumerate}
+    \item  Open the compositor window with a track selected.
+    \item  Select the camera button to enable camera editing mode.
+    \item  Drag over the display window.
+\end{enumerate}
+
+When we drag over the viewport in the compositor window, the way it looks is as if you “move the camera with the mouse”.  The viewport also moves with it.
+
+In the compositing window, there is a popup menu of options for the camera and projector. Right click over the video portion of the compositing window to bring up the menu.
+
+\begin{description}
+    \item[Reset Camera] causes the camera to return to the center position.    
+       \item[Reset Projector] causes the projector to return to the center.
+\end{description}
+
+\subsubsection*{The camera and projector tool window}%
+\label{ssub:the_camera_and_projector_tool_window}
+
+The camera and projector have shortcut operations that do not appear in the popup menu and are not represented in video overlays. 
+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.
+
+\begin{wrapfigure}[12]{O}{0.3\linewidth} 
+       \vspace{-4ex}
+    \includegraphics[width=0.9\linewidth]{images/camera_tool.png}
+    \caption{Camera and Projector tool}
+    \label{fig:images/camera_tool}
+\end{wrapfigure}
+
+In the case of the camera and projector, the tool window shows x, y, and z coordinates. 
+By either tumbling or entering text directly, the camera and projector can be precisely positioned.  
+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.
+
+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 “temporary” instead of in the center. 
+The track size is set to the original size of the video and the camera is centered. 
+The output size is set to the reduced size of the video. 
+Without any effects, this produces just the cropped center portion of the video in the output.
+
+The translation effect is dropped onto the video track. The input dimensions of the translation effect are set to the original size and the output dimensions are set to the reduced size. 
+To put the reduced video in the center subsection that the projector shows would require offsetting out x and out y by a complicated calculation. 
+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 “temporary” in the center of the output.
+
+\subsection{Masks}%
+\label{sub:masks}
+
+Masks select a region of the video for either displaying or hiding. 
+Masks are also used in conjunction with another effect to isolate the effect to a certain region of the frame. 
+A copy of one video track may be delayed slightly and unmasked in locations where the one copy has interference but the other copy does not. 
+Color correction may be needed in one subsection of a frame but not another. 
+A mask can be applied to just a subsection of the color corrected track while the plain track shows through. 
+Removal of boom microphones and airplanes are a common kind of mask uses.
+
+The order of the compositing pipeline affects what can be done with masks. Mainly, masks are performed on the temporary after effects and before the projector. This means multiple tracks can be bounced to a masked track and projected with the same mask.
+
+The compositing pipeline graph has a masking stage. 
+There are 8 possible masks per track. Each mask is defined separately, although they each perform the same operation, whether it is addition or subtraction.
+
+\subsubsection*{Compositing pipeline with masks}%
+\label{ssub:compositing_pipeline_with_masks}
+
+\begin{enumerate}
+    \item To define a mask, go into the Compositor window and enable the mask toggle.
+    \item  Next go over the video and click-drag. 
+        Note: You have to select automatic keyframes if you wish to move a mask over time.  
+        If you do not, the mask position will be the same even if you edit at different places on the timeline.
+    \item  Click-drag again in another part of the image to create each new point of the mask. 
+        While it is not the conventional Bezier curve behavior, this masking interface performs in realtime what the effect 
+        of the mask is going to be. Creating each point of the mask expands a rubber band curve.
+
+        Once points are defined, they can be moved by Ctrl-dragging in the vicinity of the corner. 
+        Shift-drag allows you to move existing points to new locations, thus altering the shape of the mask.  
+        However, this does not smooth out the curve. 
+        The In/Out points of the Bezier curve are accessed by Ctrl-dragging in the vicinity of the corner. 
+        Then Ctrl-dragging near the In or Out point causes the point to move.  
+        Shift-drag activates bezier handles to create curves between mask points.       
+
+    \item  Finally once you have a mask, the mask can be translated in one piece by Alt-dragging the mask.
+        The effect of the mask is always on.  
+        Ctrl-Alt-drag translates an entire mask to a new location on the
+        screen.
+\end{enumerate}
+
+The masks have many more parameters which could not be represented with video overlays. 
+These are represented in the tool window for masks. 
+Selecting the question mark when the mask toggle is highlighted brings up the mask options window (figure~\ref{fig:mask_window}).
+
+\begin{figure}[htpb]
+    \centering
+    \includegraphics[width=0.6\linewidth]{images/mask_window.png}
+    \caption{Mask options window}
+    \label{fig:mask_window}
+\end{figure}
+
+The mode of the mask determines if the mask removes data or makes data visible. 
+If the mode is \emph{Subtract alpha}, the mask causes video to disappear. 
+If the mode is \emph{Multiply alpha}, the mask causes video to appear and everything outside the mask to disappear.
+
+The \emph{Value of the mask}, set by a slider bar, determines how extreme the subtraction or addition is. 
+In the subtractive mode, higher values subtract more alpha. 
+In the additive mode, higher values make the region in the mask brighter while the region outside the mask is always hidden.
+
+The \emph{Mask number} determines which one of the 8 possible masks we are editing. 
+Each track has 8 possible masks. 
+When you click-drag in the compositor window, you are only editing one of the masks. 
+Change the value of mask number to cause another mask to be edited. 
+The previous mask is still active but only the curve overlay for the currently selected mask is visible. 
+When multiple masks are used, their effects are OR-ed together. 
+Every mask in a single track uses the same value and mode.
+
+The edges of a mask are hard by default but this rarely is desired. 
+The \emph{Feather} parameter determines how many pixels to feather the mask. 
+This creates softer edges but takes longer to render. 
+
+Two checkbox options are \emph{Apply mask} before plugins and \emph{Disable OpenGL masking}.  
+Note that the OpenGL mask renderer is of low quality and only suitable as a preview for initial work. 
+For fine-tuning of masks (with large feather values) \emph{OpenGL masking} should be switched off so that the software renderer is used instead.
+
+Finally, there are parameters which affect one point on the current mask instead of the whole mask. 
+These are \emph{Delete}, \emph{X}, and \emph{Y}. 
+The active point is defined as the last point dragged in the compositor window. 
+Any point can be activated merely by Ctrl-clicking near it without moving the pointer. 
+Once a point is activated, \emph{Delete} deletes it and \emph{X}, \emph{Y} allow repositioning by numeric entry.
+
+\subsection{Cropping}%
+\label{sub:cropping}
+
+
+
+Cropping reduces the visible picture area of the whole project. It changes the values of the output dimensions (width and height in pixels) and the X, Y values of the projector in a single operation. Since it changes project settings it affects all the tracks for their entire duration and it is not keyframable. 
+
+\begin{figure}[htpb]
+    \centering
+    \includegraphics[width=0.5\linewidth]{images/cropped_area.png}
+    \caption{Cropped area is in the top right corner}
+    \label{fig:images/cropped_area}
+\end{figure}
+
+\begin{itemize}
+    \item Enable the crop toggle and the tool window in the compositor window to display the Crop control dialog box.
+    \item Click-drag anywhere in the video to define the crop area. This draws a rectangle over the video.
+    \item Click-drag anywhere in the video to start a new rectangle.
+    \item Click-drag over any corner of the rectangle to reposition the corner.
+    \item Alt-click in the cropping rectangle to translate the rectangle to any position without resizing it.
+    \item The crop control dialog allows text entry of the top left coordinates (X1,Y1) and bottom right coordinates (X2,Y2) that define the crop rectangle. 
+        When the rectangle is positioned, hit the \emph{Do it} button in the crop control dialog to execute the cropping operation: the portion of the image outside  the rectangle will be cut off and the projector will make the output fit the canvas.
+    \item The Set Format window will show the new project Width and Height values.
+    \item The projector tool window will show the new X, Y values.
+    \item Track size will remain unchanged.
+\end{itemize}
+To undo the cropping enter the original project dimensions in the Set Format window and click on Reset projector in the popup menu of the compositor.
+
+\subsection{Safe Regions}%
+\label{sub:safe_regions}
+
+On consumer displays the borders of the image are cut off and within the cut-off point is a region which is not always square like it is in the compositor window. 
+The borders are intended for scratch room and vertical blanking data. 
+You can show where these borders are by enabling the safe regions toggle. 
+Keep titles inside the inner rectangle and keep action inside the outer rectangle.
+
+\begin{figure}[htpb]
+    \centering
+    \includegraphics[width=0.6\linewidth]{images/safe_regions.png}
+    \caption{Note the black frames showing the safe regions}
+    \label{fig:safe_regions}
+\end{figure}
+
+\subsection{Track and Output Sizes}%
+\label{sub:track_and_output_sizes}
+
+
+The size of the temporary and the size of the output in our compositing pipeline are independent and variable. 
+The camera's viewport is the temporary size. 
+Effects are processed in the temporary and are affected by the temporary size. 
+Projectors are rendered to the output and are affected by the output size. 
+If the temporary is smaller than the output, the temporary is bordered by blank regions in the output. 
+If the temporary is bigger than the output, the temporary is cropped.
+
+\subsubsection*{Track size}%
+\label{ssub:track_size}
+
+The temporary size is defined as the track size. 
+Each track has a different size. 
+Right click on a track to bring up the track's menu. 
+Select \emph{Resize Track} to resize the track to any arbitrary size. 
+Alternatively you can select \emph{Match output size} to make the track the same size as the output. 
+If you resize a track, then its appearance on the compositor changes accordingly. 
+Using the relationship between the track and the project's output size you can effectively reduce or magnify the size of a particular track with regards to the final output and therefore create visual effects like split screens, pans, and zooms on the compositor.
+
+\subsubsection*{Output size}%
+\label{ssub:output_size}
+
+
+The output size is set in either File$\rightarrow$\emph{New} when creating a new project or Settings$\rightarrow$\emph{Format}. 
+In the Resources window there is another way to change the output size. 
+Right click on a video asset and select \emph{Match project size} to conform the output to the asset. 
+When new tracks are created, the track size always conforms to the output size specified by these methods.
+
+When rendering, the project's output size is the final video track size where the temporary pipeline is rendered into.  
+If the output size is larger than the temporary then the image transferred from the temporary will fit inside the Output Track. 
+Any space left on the Output is left blank.  
+If the output size is smaller than the temporary then some of the temporary video will be cropped.
+
+