Credit Andrea with Windows.tex changes based on reading updates in CV manual
[goodguy/cin-manual-latex.git] / parts / Windows.tex
index ce9ae771f8b67da42ee5db192585a44c20e02449..5c8c0aeee911297fd53aeb78708565823b6f9f39 100644 (file)
@@ -84,7 +84,7 @@ Each of the symbols has an associated tooltip as an easy reminder of its functio
 several is described in a little more detail in other areas of this manual. 
 
 \vspace{2ex}
-\begin{tabular}{ll}
+\begin{longtable}{ll}
    \hline
        First set of 3 symbols & Move in the reverse direction on the timeline \\
         4th symbol & Stop play \\
@@ -105,7 +105,7 @@ several is described in a little more detail in other areas of this manual.
        Set Timecode & Explained in \ref{sub:align_timecodes}  \\
        Gang Modes & Explained in \ref{sub:displaying_tracks_ganged} \\
    \hline
-\end{tabular}
+\end{longtable}
 
 The \textit{Manual Go To} \index{goto} menu is quite versatile as you can see in figure~\ref{fig:goto_menu}.  The
 options of \textit{=} represents goto the position indicated in the textbox; \textit{+} indicates
@@ -670,7 +670,7 @@ will not include audio.
     \label{fig:compositor_window}
 \end{figure}
 
-The Compositor window (figure~\ref{fig:compositor_window}) is used to display the timeline output.  Playing and moving along the timeline video in the Program window shows in the Compositor window what the current image is.  Here is where many compositing operations are performed that can change what the timeline will look like and that is why it is called \textit{canvas}. The canvas dimesions correspond, by default, to the W/H values set in the project (\textit{Set Format} window).
+The Compositor window (figure~\ref{fig:compositor_window}) is used to display the timeline output.  Playing and moving along the timeline video in the Program window shows in the Compositor window what the current image is.  Here is where many compositing operations are performed that can change what the timeline will look like and that is why it is called \textit{canvas}. The canvas dimesions correspond, by default, to the W/H values set in the project (\textit{Set Format} window). Canvas size = output size = project size.
 
 When enabled, you can simply click the LMB in the Compositor window to start and stop play. You can zoom in and out to see small details, pan with the scrollbars, lock the window to prevent changes, add masks, and make changes with the Projector and Camera function operators. These will be explained in more detail in the following sections.
 
@@ -839,7 +839,7 @@ titles are inside the inner outline and actions are inside the outer outline.
 Much of the editing in \CGG{} involves \textit{compositing} which is the combining of visual
 elements from different sources into single images.  This includes such things as 
 speeding up and slowing down the video, changing the resolution, creating a split screen, and fading in and out.
-Compositing operations are done on the timeline and in the Compositor window using various
+Compositing operations are done on the timeline and in the Compositor window (canvas) using various
 operations and other compositing attributes that are available in the Resources window.
 When \CGG{} is performing a compositing operation it plays back through the
 compositing engine, but when not, it uses the fastest decoder that it has.
@@ -854,7 +854,7 @@ to the camera, effects, and the projector.
 \label{ssub:output_size}
 \index{temporary}
 
-\CGG{}'s compositing routines use a \textit{temporary} which is a single frame of video in memory where graphics processing takes place. By default the size of the temporary is that of the project ($W \times H$), i.e., the output size. But if the tracks on the timeline have various sizes different from those of the project, then the temporary will take the size of the active track (viewport = green border). We can also change the size of the viewport using the Camera tool, as well as pans and zooms the temporary displayed in it. Effects are processed in the temporary and as such are affected by the temporary size.  In the case of the camera, its viewport is the temporary size.  The size of the temporary and of the output in the compositing pipeline can be different and vary for any particular frame. However, projectors are rendered to the output and so are affected by the output size. The temporary is the basis on which the Projector tool acts to display the canvas on the Compositor window. The canvas always has the size of the project, although with the projector we can make pans and resizes of the red border inside it. When the temporary is smaller than the output, the temporary will have blank borders around the region in the output.  When the temporary is larger than the output, it will be cropped.
+\CGG{}'s compositing routines use a \textit{temporary} which is a single frame of video in memory where graphics processing takes place. By default the size of the temporary is that of the project ($W \times H$); i.e., the output size; i.e, the canvas size. But if the tracks on the timeline have various sizes different from those of the project, then the temporary will take the size of the active track (viewport = green border). We can also change the size of the viewport using the Camera tool, as well as pans and zooms the temporary displayed in it. Effects are processed in the temporary and as such are affected by the temporary size.  In the case of the camera, its viewport is the temporary size.  The size of the temporary and of the output in the compositing pipeline can be different and vary for any particular frame. However, projectors are rendered to the output and so are affected by the output size. The temporary is the basis on which the Projector tool acts to display the canvas on the Compositor window. The canvas always has the size of the project, although with the projector we can make pans and resizes of the red border inside it. When the temporary is smaller than the output, the temporary will have blank borders around the region in the output.  When the temporary is larger than the output, it will be cropped.
 
 \subsubsection*{Track and Output size}%
 \label{ssub:track_size}
@@ -884,43 +884,23 @@ If we load a media (M) into Resources and adjust the size of the project to the
 \index{aspect ratio}
 \index{PAR, DAR, SAR}
 
-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.
-
+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.78); in cinema we use the 35 mm aspect ratio of 1.375 (Academy aperture), academy flat (1.85 or widescreen) but even more so the super 35 mm (from 1.33 to 2.39). There are also anamorphic formats, i.e. that have no square pixels, like Cinemascope (2.39). The projection must be 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.
+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 video 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 \textit{Camera} tool you choose the size and aspect ratio of the source file (regardless of the original size); while with the \textit{Projector} tool you choose the size and aspect ratio of the output. Other ways of changing the aspect ratio of assets or tracks we have seen previously (\texttt{Resize track}; \texttt{Match Output Size}; \texttt{Resize asset}). A method of changing the size of the entire project (canvas) is via the \texttt{Set Format} window. The following formula is used to vary the aspect ratio:
 
-The following formula is used to vary the aspect ratio:
+\qquad $\frac{W}{H} =$ frame aspect ratio ($\frac{pixels}{pixels}$)
 
-\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:
+For example to obtain an aspect ratio of Super 35 mm (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)
+from which: $H = 816$ pixels
 
-In practice, there can be a problem with anamorphic format rendering as desired because it does
-not use square pixels.  So, for example, FFV1 format in the mkv container will ignore the DAR
-(Display Aspect Ratio).  You can check if your media is anamorphic format using the \textit{Mediainfo}
-program.  If the Width/Height is 720/576 (=1.25) and DAR is 16/9 (=1.777) then you have non-square
-pixels.  SAR (Storage Aspect Ratio) is different from DAR and you have to use a workaround as 
-described at the "Cinelerra for Grandma" site by Raffaella Traniello:
-{\small\url{http://www.g-raffa.eu/Cinelerra/HOWTO/anamorphic.html}} . 
+At the same time as changing the \textit{Height} parameter we also need to set \texttt{Display Aspect rati}o to 2.35. In fact, the parameters in Canvas Size are not related to those in Display Aspect ratio, unless we keep the \texttt{Auto} option checked, and we need to set both before we click on the \texttt{Apply} button. To set the aspect ratio to 2.35:1 we can choose from the drop-down menu the value 2.35 or set the value directly in the two input fields. Or again, it can be done automatically via the Auto option. Finally we can click on the Apply button to complete the calculations. Now we have arrived at the desired result: typical Super 35 mm dimensions and aspect ratio, although starting from a 16:9 FullHD. The new canvas, however, lost the pixels of a part of the initial video (crop), to be precise $1080 - 816 = 264$ lines of pixels from top and bottom.
 
+\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 (Width/Height) or by setting a multiplication coefficient (W/H Ratio; in this example: placing $H Ratio = 816 : 1080 = 0.7556$) which performs the calculation automatically. If you set \textit{W Ratio} and \textit{H Ratio} at the same time with the same values, they work as multipliers and you get a resizing of the canvas, without altering the initial aspect ratio. If you change them to two different values or change only one of the two parameters, leaving the other at 1, you get an anamorphic video, with the pixels no longer being square (1:1) but becoming rectangular, deforming the image. If you use a non-standard aspect ratio, this has impact on other areas like titles, included stills and included non-anamorphotic footage. To avoid anamorphosis, the \texttt{Display Aspect ratio} must also be adjusted at the same time, for example, with the Auto option. \textit{Anamorphic} format is a complex field that is discussed
+in Andrea's paper: {\small \url{https://cinelerra-gg.org/download/Anamorphic.pdf}}.
+as well as in the Raffaella Traniello's guide: {\small \url{http://www.g-raffa.eu/Cinelerra/HOWTO/anamorphic.html}}.
 
 \subsection{Camera and Projector}%
 \label{sub:camera_and_projector}
@@ -994,7 +974,7 @@ with the mouse.  The viewport moves in the same manner.
 
 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. 
-The green box is the Viewport; at the beginning it coincides with the size of the source frame. If we move the viewport by dragging it with LMB (moving it in $x/y$), the green box remains fixed to the original size but the frame is moved to the new position.  A yellow frame will appear along the edges of the frame to indicate the displacement with respect to the green box; this behavior differs from that seen for the Projector. Even if we act on the $z-axis$ (SHIFT + Drag, equivalent to the zoom), the frame narrows or widens, moving behind the yellow frame.
+The green box is the Viewport; at the beginning it coincides with the size of the source frame. If we move the viewport by dragging it with LMB (moving it in $x/y$), the green box remains fixed to the original size but the frame is moved to the new position.  A yellow frame will appear along the edges of the frame to indicate the displacement with respect to the green box; this behavior differs from that seen for the Projector. Even if we click on the $z-axis$ (SHIFT + Drag, equivalent to the zoom), the frame narrows or widens, moving behind the yellow frame.
 
 \subsubsection*{Camera and Projector Menu}%
 \label{ssub:camera_and_projector_menu}
@@ -1013,7 +993,7 @@ Most operations in the Compositor window have a tool window which is enabled by
        \label{fig:camera_tool}
 \end{figure}
 
-In the \textit{Position} section you can act on the $X$, $Y$ and $Z$ coordinates. By either tumbling or entering text directly or by using the slider, the camera and projector can be precisely positioned. There is also a reference to the color of the curve as we see it on the timeline. You can also define the \textit{range} of action which by default is [-100 to 100]. By pressing the Reset button for each coordinate, or the global Reset button, the range is automatically brought to the project size value (HD; 4k; etc), which are usually the most useful limits. Note that the range can also be changed in the \textit{Program} window, in the \textit{zoom bar}, where there are similar input fields to enter the chosen limits.
+In the \textit{Position} section you can change the $X$, $Y$ and $Z$ coordinates. By either tumbling or entering text directly or by using the slider, the camera and projector can be precisely positioned. There is also a reference to the color of the curve as we see it on the timeline. You can also define the \textit{range} of action which by default is [-100 to 100]. By pressing the Reset button for each coordinate, or the global Reset button, the range is automatically brought to the project size value (HD; 4k; etc), which are usually the most useful limits. Note that the range can also be changed in the \textit{Program} window, in the \textit{zoom bar}, where there are similar input fields to enter the chosen limits.
 
 In the \textit{Justify} section we can use automatic positioning in the 6 standard coordinates: Left, Horizontal, Right, Top, Center and Bottom.
 
@@ -1650,27 +1630,47 @@ Below are steps illustrating an easy way to set up a new folder.
        \label{fig:folder_master}
 \end{figure}
 
-Adding the Shift key before the actual drop, will allow for relative path filenames instead of full path.
+\subsection{Modify Folder: sorting the media}%
+\label{sub:sorting_media}
+\index{folder modify}
 
-\textbf{Sort the media}. After creating the new folder we can populate it automatically through a choice of filters. This provides functionality similar to \textit{Smart Bins}. Once the folder is populated we can still take action to change the filters and thus the sorting, loading or deleting of some media. Creating new folders and populating them with Modify Folder is akin to the \textit{Logging} phase of professional workflows. Let us examine the Modify folder window in detail: 
+In \CGG{} all the virtual mediafiles loaded in the \textit{Resources} window are collected in the \texttt{Media} folder without any kind of organization and sorting other than alphabetical. The Media folder is considered a \textit{master} folder because it is the basis for every other new folder we create. Another \textit{master} folder is \texttt{Clips}, and in fact we can create new clips folders as well. If we do editing of large projects containing numerous mediafiles, a rational and selective organization of the source material becomes necessary. In fact, having the sources organized in folders, where they can be found and used easily, makes subsequent editing much faster, as well as minimizing confusion and the possibility of errors. This step, which is fundamental in the pro environment, is called \textit{Logging} and also includes \textit{screening} individual mediafiles in the Viewer window; \textit{renaming} them rationally; and adding labels and descriptions in the \textit{metadata}.
 
-When you bring up the Modify folder window, if you already have files in that folder, you will see filters that were generated automatically when you did a Drag and Drop. See figure~\ref{fig:modify-target}.
+We start by creating one or more new folders (MediaUserBin). These will be empty and we should populate them with the mediafiles contained in the master Media folder. There are two options: manual \textit{Drag and Drop} or automatic populating by setting \textit{filters} (Smart Bins).
+
+\paragraph{Drag and Drop:} you drag mediafiles into the new folder one by one or in selected groups. The starting master folder can only be \texttt{Media} (or \texttt{Clips}, if we have created a new clip folder). Dragging is done by preserving the absolute path of the sources. If you open Modify Folder window you will notice that each imported mediafile occupies a different row characterized by its own path and name. See figure~\ref{fig:modify-target}. The \texttt{Value} field containing paths can contain only 63 characters, and it may happen to find the names cut off. The full path and name can be found by right-clicking on the row, but this is inconvenient and time-consuming. The best solution is to drag the mediafiles while holding down the \texttt{Shift} key; this will return the relative path instead of the absolute path, with space gain.
 
+\begin{figure}[htpb]
+       \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.7\linewidth]{folder_modify.png}};
+               \node [yshift=-20mm, xshift=-1cm,anchor=east] at (img1.north west) (Arrow1) {\parbox{8em}{Here is the filter that was generated with the original drop }};
+               \draw [->, line width=1mm] (Arrow1) edge  ([yshift=-20mm] img1.north west);
+       \end{tikzpicture}
+       
+       \caption{Modify Folder}
+       \label{fig:modify-target}
+\end{figure}
 
+\paragraph{Filters:} you do automatic populating using filters (Smart Bins mode). You set the values of the \texttt{Enabled}; \texttt{Target}; \texttt{Op} and \texttt{Value} fields to make up the required filtering. The folder will populate automatically by pulling from the \texttt{Media} master folder. The filter is the result of one row, but we can do more sophisticated filtering by adding more rows. The process will start from the first row propagating to subsequent rows always following the pattern from top to bottom. See figure~\ref{fig:modify_folder}.
 
 \begin{figure}[htpb]
-    \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.7\linewidth]{folder_modify.png}};
-        \node [yshift=-20mm, xshift=-1cm,anchor=east] at (img1.north west) (Arrow1) {\parbox{8em}{Here is the filter that was generated with the original drop }};
-        \draw [->, line width=1mm] (Arrow1) edge  ([yshift=-20mm] img1.north west);
-        \end{tikzpicture}
-        
-    \caption{Modify Folder}
-    \label{fig:modify-target}
+       \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.8\linewidth]{modify_folder1.png}};
+               \node (img2) [yshift=-1cm, xshift=3.5cm, rotate=0] at (img1) {\includegraphics[width=0.8\linewidth]{modify_folder2.png}};
+               \node (img3) [yshift=-1cm, xshift=3cm, rotate=0] at (img2){\includegraphics[width=0.5\linewidth]{modify_folder3.png}};
+       \end{tikzpicture}
+       \caption{The available choices for each field. Value field missing.}
+       \label{fig:modify_folder}
 \end{figure}
 
+Let's look in detail at all the options of Modify Folder. 
+
+When you bring up the Modify folder window, if you already have files in that folder, you will see filters that were generated automatically when you did a Drag and Drop. See figure~\ref{fig:modify-target}.
+
 When you click on the \textit{Value} portion of that filter, the entire set of files that are covered by the filter rules pops up.   Now you can highlight a target filename that you would like to remove, and just erase that line and check the green checkmark for OK.
 
 To delete the entire set of files listed on the filter rule, highlight the rule line and hit the \textit{Del} button. 
@@ -1684,20 +1684,6 @@ But once you hit Apply, clicking on the red X button will not undo your changes.
 The filter/search rules are applied in the order listed in the Modify folder window.  
 You can change the order of the filter rules by highlighting the rule you want to move and then drag and drop to a new location.
 
-The figure~\ref{fig:modify_folder} below displays the available choices for each field.
-
-\begin{figure}[htpb]
-    \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.8\linewidth]{modify_folder1.png}};
-        \node (img2) [yshift=-1cm, xshift=3.5cm, rotate=0] at (img1) {\includegraphics[width=0.8\linewidth]{modify_folder2.png}};
-        \node (img3) [yshift=-1cm, xshift=3cm, rotate=0] at (img2){\includegraphics[width=0.5\linewidth]{modify_folder3.png}};
-    \end{tikzpicture}
-    \caption{The available choices for each field. Value field missing.}
-    \label{fig:modify_folder}
-\end{figure}
-
 Information about the columns and rules for the search filters in the Modify folder window follows \index{folder add filter/search}.
 
 Column headers:
@@ -1794,7 +1780,6 @@ Column headers:
 
 Table showing the allowed usage:
 
-%TODO create table for below code
 \begin{lstlisting}[numbers=none]
 target:    |  eq  ge  gt  ne  le  lt   matches  around
 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++
@@ -1831,24 +1816,25 @@ Examples with some caveats first:
     \item   Sort is by filename base name (directory path not included automatically) except when the \textit{Around} operation is used and then it is sorted by that Target distance first and then filename.
 \end{enumerate}
 
-\begin{table}[htpb]
-    \centering
-    \caption{Examples}
-    \label{tab:label}
-    \small
-    \begin{tabular}{lllm{10em}m{10em}} \toprule
-        Enable&        Target& Op&     Value&  meaning\\\midrule
-Or     &Patterns  &Matches   &*&        all files from the Media folder are included\\
-And Not&Filesize&Lt    &160000000& no files that are less than 160MB in size \\
-Or Not&        Time    &Ge     &2018/07/30 06:13:00    & files not greater than or equal date\\
-And    &Duration&Eq    &01:00          & files included must have 60 secs. Duration\\
-Off    &Samplerate&Ne  &44000          & off for now, but may want to include later\\
-And    &Framerate&Around&24+1          & files included all have 24 to 25 framerate\\
-Or     &Patterns&Matches&[*.mp4]       & all files with the extension of mp4\\
-Or     &Time&  Around&2018/08/02 06:00:00 + 02:00:00  & files at 4AM to 8 AM\\\bottomrule
-    \end{tabular}
-\end{table}
-
+\begin{longtable}{lllm{10em}m{10em}}
+       \caption{Examples}
+       \label{tab:label}\\
+       \toprule
+       \textbf{Enable} & \textbf{Target} & \textbf{OP} & \textbf{Value} & \textbf{meaning} \\
+       \hline
+       %begin{latexonly}
+       \endhead
+       %end{latexonly}
+       Or & Patterns & Matches & * & all files from the Media Folder are included \\
+       And Not & Filesize & Lt & 160000000 & no files that are less than 160MB in size \\
+       Or Not & Time & Ge & 2018/07/30 06:13:00 & files not greater than or equal date \\
+       And & Duration & Eq & 01:00 & files included must have 60 secs. Duration \\
+       Off & Samplerate & Ne & 44000 & off for now, but may want to include later \\
+       And & Framerate & Around & 24+1 & files included all have 24 to 25 framerate \\
+       Or & Patterns & Matches & [*.mp4] & all files with the extension of mp4 \\
+       Or & Time & Around & 2018/08/02 06:00:00 + 02:00:00 & files at 4 AM to 8 AM \\
+       \bottomrule
+\end{longtable}
 
 \subsection{Vicons \& Aicons – aka Video Icons / Audio Icons}%
 \label{sub:vicons_aicons_aka_video_icons_audio_icons}