corrections from Andrea on colorspace, fixed cutoff chapter numbers, some plugins...
[goodguy/cin-manual-latex.git] / parts / Windows.tex
1 \chapter{The 4+ Windows}%
2 \label{cha:the_4_windows}
3
4 \begin{figure}[htpb]
5     \centering
6     \includegraphics[width=\linewidth,keepaspectratio]{images/Fenstergrundposition-en.png}
7     \captionsetup{labelformat=empty, textformat=empty}
8     \caption[The four windows (cc-by-sa Olaf)]{No text}    
9     \label{fig:Fenstergrundposition-en}
10 \end{figure}
11
12 \section{Program Window}%
13 \label{sec:program_window}
14
15 The main window is called the \textit{Program} window and is often just referred to as the \textit{timeline}.  Here is where you enter the main menu operations.  
16 This timeline consists of a vertical stack of tracks with time represented horizontally on the track. 
17 It is the output of the rendering operations and this is what is saved when you run the File Save command.
18 Immediately to the left of the timeline is the patchbay. The patchbay contains options that affect each track.  
19 These options are described in great detail in the Editing section (\ref{sec:patchbay}).
20
21 The \textit{Window} pulldown on the main window contains options that affect the 4 main windows. The first 3 options are used to display each of the windows in case one is accidentally closed.  You can
22 move or resize the windows as needed, save that particular layout, and revert to the default positions
23 to reposition all 4 windows to the original screen configuration.
24 On dual headed displays, the Default positions operation fills only one monitor with windows, but as you
25 can see in the \textit{Window} pulldown you have more options to change that. Usage with dual monitors is
26 explained in \ref{sec:multiscreen_playback_configuration}.
27
28 \subsection{Video and Audio Tracks and Navigation}%
29 \label{sub:video_and_audio_tracks_and_navigation}
30
31 The \textit{Program} window (figure~\ref{fig:patchbay}) has many features for navigation and displays the timeline as it is structured in memory. The tracks are stacked vertically with horizontal movement over time.
32 There is a vertical scroll bar which allows for moving across tracks and a horizontal scroll bar for scanning across time. 
33
34 \begin{figure}[htpb]
35     \centering
36     \includegraphics[width=0.8\linewidth]{images/patchbay.png}
37     \caption{Patchbay  | Timeline with pulldowns, navigation icons, Video/Audio tracks | bottom Zoom Panel}
38     \label{fig:patchbay}
39 \end{figure}
40
41 Video tracks represent the duration of your media, just as if you placed old-fashioned rolls of photographic
42 film one right after the other along a table.
43 Individual images that are drawn on each track are snapshots of what is located at that place on the timeline.
44
45 Audio tracks represent the sound media as an audio waveform, or if you change a preference settings, a rectified audio waveform. 
46 This too looks like old-fashioned digital magnetic tape laid out horizontally across a table.
47 Using the \textit{Zoom Panel} controls at the bottom of the timeline,
48 you can adjust the horizontal and vertical size of the video and audio waveform displays.
49 Each track on the timeline has a set of attributes on its left side in the patchbay which is used to 
50 control some options of that particular track. 
51
52 Track Navigation is performed by selecting a video or audio track and moving to a certain time in the track. 
53 Use the vertical scroll bar to scan across tracks. or even easier you can use the mouse wheel. 
54 And use the horizontal scroll bar to scan across time, or again even easier, you can use the mouse wheel with the Ctrl key.  
55
56 Once you have become familiar with many of the graphical tools and pulldowns, you can switch to using more of
57 the keyboard to navigate.  Many of the key equivalences are listed in the pulldowns to the right of the option
58  as a shortcut. All of the shortcuts are listed in a document for keyboard 
59 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.  
60 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.
61
62 \subsection{Zoom Panel}%
63 \label{sub:zoom_panel}
64
65 Below the displayed tracks in the timeline, you will find the zoom panel as seen in figure~\ref{fig:patchbay}.
66 In addition to the scrollbars, these options and their values are another set of tools for positioning the timeline.  
67 In order of appearance in the zoom panel as rectangular boxes and up/down arrows, this next list shows each option along with its tooltip description if available.
68 Then more details are provided in the next paragraphs.
69
70 \vspace{2ex}
71 \begin{tabular}{ l  l }
72    \hline
73         Sample zoom & Duration visible on the timeline \\
74         Amplitude & Audio waveform scale \\
75         Track zoom & Height of tracks in the timeline \\
76           (type) & Automation Type \\
77         Curve zoom & Automation range minimum and maximum \\
78         Selection change & 3 boxes with starting point, length, and ending point \\
79         Alpha slider & Slider bar to control alpha value for colored assets \\
80    \hline
81 \end{tabular}
82
83 Changing the \emph{sample zoom} causes the unit of time displayed in the timeline to change size. 
84 So you can view your media all the way from individual frames to the entire length of your media. 
85 The higher the setting, the more frames you can see per screen. 
86 The sample zoom value is not an absolute reference for the unit of time since it refers to the duration visible on the timeline and thus changes also as you modify the length of the program window horizontally.
87 Use the $\uparrow$ and $\downarrow$ arrows to change the sample zoom by a power of two. 
88 Or if your mouse has a wheel, mouse over the tumblers and use the wheel to zoom in and out.
89
90
91 The \emph{amplitude} only affects audio which determines how large the waveform appears. \texttt{Ctrl-$\uparrow$} and \texttt{Ctrl-$\downarrow$} cause the amplitude zoom to change.
92
93 The \emph{track zoom} affects all tracks. 
94 It determines the height of each track. 
95 If you change the track zoom, the amplitude zoom compensates so that the audio waveforms look proportional. 
96 \texttt{Ctrl-Pgup} and \texttt{Ctrl-Pgdown} cause the track zoom to change.
97
98 \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).
99  
100 The \emph{curve zoom} affects the curves for the selected \emph{automation type} in all the tracks of that type and determines the value range for those curves. 
101 Use the left up/down arrows for the minimum value and the right up/down arrows for the maximum value or manually enter the values in the text box. 
102 Good default values for audio fade are -40.0 to 6.0 and for video fade are 0.0 to 100.0. 
103 The up/down arrows change curve amplitude, but the only way to curve offset is to use the fit curves button.
104
105 The \emph{selection start time}, \emph{selection length}, and \emph{selection end time} display the current selected timeline values.  
106 The \emph{alpha slider} allows for varying the alpha value when using colors on the tracks as set in your \texttt{Preferences $\rightarrow$ Appearance} for \texttt{Autocolor assets}.  
107 It has no function without that flag set.
108
109 \subsection{Track Popup Menu}%
110 \label{sub:track_popup_menu}
111
112 Each Track has a popup menu. 
113 To activate the track popup menu, Right mouse click (RMB) on the track. 
114 The popup menu affects the track whether the track is armed on the patchbay or not. 
115 The Track Menu contains a number of options:
116
117 \begin{description}
118     \item[Attach Effect] opens a dialog box of effects applicable to the type of track of audio or video.
119     \item[Move up] moves the selected track one step up in the stack.
120     \item[Move down]  moves the selected track one step down in the stack.
121     \item[Delete track]  removes the track from the timeline.
122     \item[Add Track]  adds a track of the same media type, audio or video, as the one selected above that track.
123     \item[Find in Resources]  that media file will be highlighted in the media folder in the Resources window.
124     \item[Show edit]  will point out the exact start and stop points along with the length of the current edit on
125         that track as well as the media name.
126     \item[User title]  is used to change the title name.  This is really handy for files that have very long and
127         similar names that would get cut off during edits.  You can use short names to better differentiate the
128         media. If you select multiple, all those clips will have title name changed.
129     \item[Bar color]  allows the user to select a specific color for the title bar.  This helps ease of locating.
130     \item[Resize Track]  resizes the track.
131     \item[Match Output Size]  resizes the track to match the current output size.
132 \end{description}
133
134
135 \subsection{Insertion Point}%
136 \label{sub:insertion_point}
137
138 The insertion point (figure~\ref{fig:insertion-points}) is the flashing hairline mark that vertically spans the timeline in the program window. 
139 Analogous to the cursor on your word processor, the insertion point marks the place on the timeline where the next activity will begin. 
140 It is the point where a paste operation takes place. 
141 When rendering, it defines the beginning of the region of the timeline to be rendered. It is also the starting point of all playback operations.
142
143 Normally, the insertion point is moved by clicking inside the main timebar. 
144 Any region of the timebar not obscured by labels and in or out points is a hotspot for repositioning the insertion point. 
145 In cut and paste editing mode only, the insertion point can be moved also by clicking in the timeline itself. 
146 When moving the insertion point the position is either aligned to frames or aligned to samples. 
147 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 \texttt{Settings$\rightarrow$Align cursor on frames}.
148
149 \begin{figure}[htpb]
150     \centering
151     %\includegraphics[width=0.8\linewidth]{name.ext}
152     \begin{tikzpicture}[scale=1, transform shape]
153         \node (img1) [yshift=0cm, xshift=0cm, rotate=0] {\includegraphics[width=0.6\linewidth]{images/insertion-point.png}};
154         \node [yshift=-13mm, xshift=-1cm,anchor=east] at (img1.north west) (Pulldowns) {Pulldowns};
155         \node [yshift=-20mm, xshift=-1cm,anchor=east] at (img1.north west) (Transport) {Transport \& Buttons Bar};
156         \node [yshift=-27mm, xshift=-1cm,anchor=east] at (img1.north west) (Timebar) {Timebar};
157         \node [yshift=-33mm, xshift=-1cm,anchor=east] at (img1.north west) (Title) {Media Title };
158         \node [yshift=-43mm, xshift=-1cm,anchor=east] at (img1.north west) (Video) {Video Track};
159         \node [yshift=-63mm, xshift=-1cm,anchor=east] at (img1.north west) (Audio) {Audio Track};
160         \draw [->, line width=1mm] (Pulldowns) edge  ([yshift=-13mm] img1.north west);
161         \draw [->, line width=1mm] (Transport) edge  ([yshift=-20mm] img1.north west);
162         \draw [->, line width=1mm] (Timebar) edge    ([yshift=-27mm] img1.north west);
163         \draw [->, line width=1mm] (Title) edge      ([yshift=-33mm] img1.north west);
164         \draw [->, line width=1mm] (Video) edge      ([yshift=-43mm] img1.north west);
165         \draw [->, line width=1mm] (Audio) edge      ([yshift=-63mm] img1.north west);
166         \end{tikzpicture}
167     
168     \caption{Insertion point is at 0:00:25:10 in Hr:Mn:Sec:Frames}
169     \label{fig:insertion-points}
170 \end{figure}
171
172
173 \subsection{Editing Modes}%
174 \label{sub:editing_modes}
175
176 There are 2 different editing methods of operation that affect the insertion point and the editing on the timeline.  
177 There is:  \emph{drag and drop mode} and \emph{cut and paste mode}. 
178 The editing mode is determined by selecting the \texttt{arrow} or the \texttt{I-beam} in the Transport and Buttons bar. 
179
180 If the arrow is highlighted, it enables \emph{drag and drop mode}.  
181 In drag and drop mode, clicking in the timeline does not reposition the insertion point.  
182 Double-clicking in the timeline selects the entire edit the mouse pointer is over.  
183 Dragging in the timeline repositions the edit the mouse pointer is over. 
184 This is useful for reordering audio playlists, sorting movie scenes, or moving effects around. 
185 To cut and paste in drag and drop mode you need to set In/Out points to define an affected region. 
186
187 If the I-beam is highlighted it enables \emph{cut and paste mode}. 
188 In cut and paste mode, clicking (LMB) in the timeline repositions the \textit{Insertion Point}. 
189 Double-clicking in the timeline selects the entire edit the cursor is over (column). 
190 Dragging in the timeline highlights a region. 
191 The highlighted region becomes the region affected by cut and paste operations and the playback range during the next playback operation. 
192 Shift-clicking in the timeline extends the highlighted region.
193
194 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 \texttt{Settings $\rightarrow$ align cursor on frames}.
195
196 \begin{figure}[htpb]
197     \centering
198     \includegraphics[width=0.4\linewidth]{images/i-beam.png}
199     \caption{I-beam + in/out  +  labels}
200     \label{fig:i-beam}
201 \end{figure}
202
203 \subsection{In/Out Points}%
204 \label{sub:in_out_points}
205
206 In both editing modes, you can set one In point and one Out point. 
207 The in/out points define the affected region. In the timebar, a colored bar will appear between [ and ] to better highlight the area between the In and Out Points.
208 In drag and drop mode, they are the only way to define an affected region.
209
210 In both cut and paste mode and drag and drop mode, the highlighted area overrides the In/Out points. 
211
212 If a highlighted area and In/Out points are set, the highlighted area is affected by editing operations and the In/Out points are ignored. 
213 If no region is highlighted, the In/Out points are used. 
214 To avoid confusion, it is better to use either highlighting or In/Out points but not both simultaneously.
215
216 To set in/out points, go to the timebar and position the insertion point somewhere. 
217 LMB the In point button. 
218 Move the insertion point to a position after the In point and click the Out point button. 
219 Instead of using the button bar, you can use the [ or < and ] or > keys to toggle in/out points.
220
221 If you set the insertion point somewhere else while In/Out points already exist, when you click the In/Out buttons the existing points will be repositioned. 
222 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.
223
224 If you select either the In point or the Out point, the insertion point will jump to that location. 
225 After selecting an In point, if you click the In point button the In point will be deleted. 
226 After selecting an Out point, if you click the Out point button the Out point will be deleted. 
227 Shift-clicking on an In/Out point highlights the region between the insertion point and that In/Out point. 
228 If a region is already highlighted, it extends the highlighted region up to that In/Out point.
229
230 To quickly get rid of In/Out points, without caring about where they are or if they are set or not, just double click on [ and ] buttons. 
231 The first click will set a new point or reposition an old one at the insertion point; the second click will delete it. This trick does not work if the In point or the Out point is already set at insertion point.
232
233 Some of the useful operations concerning the In/Out pointers are listed next.
234
235 \begin{description}
236     \item[Ctrl-KeyPad\#]  if in/out set, \texttt{KP 2,3,5,6 + Enter}, play between In/Out point
237     \item[Shift-Ctrl]  loops play between In/Out points
238     \item[Click in/out] while holding the left mouse button, drags In/Out pointer elsewhere
239     \item[Shift-Ctrl] with transport button, loops play between In/Out points
240     \item[Ctrl-t]  clears both In/Out points
241 \end{description}
242
243 \subsection{Labels}%
244 \label{sub:labels}
245
246 The insertion point and the In/Out points allow you to define an affected region, but they do not let you jump to exact points on the timeline very easily. 
247 Labels are an easy way to set exact locations on the timeline that you want to jump to. 
248 When you position the insertion point somewhere and click the label button, a new label appears on the timeline. 
249 With label traversal you can quickly seek back and forth on the timeline.
250
251 No matter what the zoom settings are, clicking on the label highlights it and positions the insertion point exactly where you set the label. 
252 The lower case letter “\texttt{L}” is a shortcut for the label button.
253
254 Labels can reposition the insertion point when they are selected but they can also be traversed with the label traversal buttons. When a label is out of view, the label traversal buttons reposition the timeline so the label is visible. Keyboard shortcuts for label traversal are:
255
256 \begin{description}
257     \item[Ctrl-left] repositions the insertion point on the previous label.
258     \item[Ctrl-right] repositions the insertion point on the next label.
259 \end{description}
260
261 The Label folder in the Resources window lists the timestamp of every label. 
262 You can edit the label list and add a title for every item using the popup menu. 
263 To open the Label info dialog right click on the label icon in the Resources window or directly on the label symbol on the timebar. 
264 With labels you can also select regions:
265
266 \begin{description}
267     \item[Shift-Ctrl-left] highlights the region between the insertion point and the previous label.
268     \item[Shift-Ctrl-right] highlights the region between the insertion point and the next label.
269     \item[Double-clicking] on the timebar between two labels highlights the region between the labels.     
270     \item[Shift-clicking] on a label highlights the region between that label and the insertion point.
271         If a region is already highlighted, it extends the highlighted region up to that label.
272 \end{description}
273
274
275 If you hit the label button when a region is highlighted, labels are created at each end of the highlighted region. 
276 However, if one end already has a label, then the existing label is deleted. 
277 Hitting the label button again when a label is selected deletes it. 
278 Manually hitting the label button or L key over and over again to delete a series of labels can get tedious. 
279 To delete a set of labels, first highlight a region, then use the \texttt{Edit $\rightarrow$ Clear labels} function. 
280 If in/out points exist, the labels between the in/out points are cleared and the highlighted region is ignored.
281
282
283 In Cut and Paste editing mode only, by enabling \emph{Edit labels} in the settings menu or by disabling the \emph{Lock labels from moving} button on the program toolbar, labels will be cut, copied or pasted along with the selected region of the first armed track. 
284 Similarly, if a selected area of a resource is spliced from the viewer to the timeline in a position before labels, these labels will be pushed to the right on the timebar for the length of the selected area. 
285 To prevent labels from moving on the timebar, just disable the \emph{Edit labels} option or enable the \emph{Lock labels from moving} button.
286
287
288 Originally in Drag and Drop editing mode labels will be always locked to the timebar, even with the \emph{Edit labels} option enabled.  
289 This may no longer be correct in all cases. 
290
291 \subsection{Color Title Bars and Assets}%
292 \label{sub:color_title_bars_and_assets}
293
294 In order to visually aid in locating clips on the timeline that are from the same media file, you can have them auto-colored or self-colored.  
295 Use of this feature requires additional memory and cpu on every timeline redraw, therefore it is recommended that smaller computers leave it turned off.
296
297 For auto-color the color will be based on a hashed filename so that whenever you load this particular media, it will always have the same color on the title bar even if you use proxy.  
298 To enable auto-color (figure~\ref{fig:autocolor_assets}, go to \texttt{Settings $\rightarrow$ Preferences, Appearance tab} and check on \texttt{Autocolor assets}.  
299 It is disabled by default.  
300 Each media will have a random muted color and there could easily be close duplicates as generated by the program algorithm.  There will be no total black, but some dark shades are possible.  
301
302 Screencast shows the red colored checkmark to enable Autocolor assets.  
303 In the lower left corner is Highlighting Inversion color which can also be set and is discussed elsewhere.
304
305 \begin{figure}[htpb]
306     \centering
307     \includegraphics[width=0.8\linewidth]{images/autocolor-assets.png}
308     \caption{Autocolor assets}
309     \label{fig:autocolor_assets}
310 \end{figure}
311
312 To change a specific clip to your own chosen color, middle mouse button (MMB) over that clip and an Edits popup will be displayed.  
313 Choose the option \textit{Bar Color} to bring up the color picker and choose a color.   
314 You can also change the alpha value in the color picker and this alpha takes precedence over the current alpha slider bar value unless it was set to 1.0.   
315 The color will only change after you click on the checkmark.  
316 The \emph{Bar Color} option works in either Drag and Drop or Cut and Paste editing mode and also works if \textit{Autocolor assets} is not set.  
317 In Drag and Drop editing mode, if you select several clips and then bring up the Edits popup with the middle mouse button over a track, you can use the \emph{Bar Color} option to change all of those selected to the same color.
318
319 To go back to the default colors, uncheck \textit{Autocolor assets} in Preferences, but this does not affect the specially chosen self-colored ones as they are preserved.  
320 To change these individually or  selectively use the Edits popup \emph{Bar Color} option and click on \textit{Default} in the color picker window.  Auto-color does not honor armed/disarmed tracks.  
321 Self-color does honor armed/disarmed tracks.
322
323 And that’s not all!  
324 There is an \emph{alpha fader slider bar} on the bottom of the main window on the right hand side of what is referred to as the Zoom Panel.  
325 With this alpha slider, you can colorize your video and audio tracks to either see only the color at 0.0 or see only the image/audio waveform at 1.0.  
326 This slider bar affects all colored areas of the Autocolor assets and the self-colored ones.  
327 In the case when a specifically changed edit alpha value is any value except 1, the slider bar will not affect that.  
328 Once you use the slider bar, it is activated so gets first shot at any keystrokes in the main window.  
329 You deactivate this by simply clicking in a different part of the main window.  
330
331 As long as we are on the subject of color, just a reminder that you can also change the \textit{Highlighting Inversion color} in \texttt{Settings $\rightarrow$ Preferences, Appearance tab}.  
332 This is on right left hand side of the menu more than half the way down and you can see this in the figure~\ref{fig:autocolor_assets}.  
333 That setting defaults to white ($ffffff$) but sometimes this is a little bright so you can put any hex value in that suits you.
334
335 Screencast (figure~\ref{fig:autocolor_assets_alpha}a) which shows an example of the Autocolor assets with alpha set to 0.0.
336 In this screencast (figure~\ref{fig:autocolor_assets_alpha}b), the alpha is set to show the image as well as the colors.  The pink media file has been self-colored rather than the autocolor to make it easy to see.
337
338 \begin{figure}[htpb]
339     \centering
340     \begin{minipage}[h]{0.55\linewidth}
341         \center{\includegraphics[width=0.99\linewidth]{images/autocolor-assets_alpha0.png}} \\ a)
342     \end{minipage}
343     \begin{minipage}[h]{0.4\linewidth}
344         \center{\includegraphics[width=0.99\linewidth]{images/autocolor-assets_alpha1.png}} \\ b)
345     \end{minipage}
346     \caption{An example of the Autocolor assets}
347     \label{fig:autocolor_assets_alpha}
348 \end{figure}
349
350
351 \subsection{More about Pulldowns}%
352 \label{sub:more_about_pulldowns}
353
354 The main window pulldowns are quite obvious in their meaning and usage, so here is only a summary.  
355 %TODO Figure 3 shows an example of the pulldowns as displayed in the main window.Appearance
356
357
358 \begin{description}
359     \item[File]  options for loading, saving, and rendering as described in other sections (\ref{cha:load_save_and_the_EDL}).
360     \item[Edit]  edit functions; most of which have shortcuts that you will quickly learn.
361     \item[Keyframes]  keyframe options which are described in the Keyframe section (\ref{cha:keyframes}).
362     \item[Audio]  audio related functions such as \textit{Add track}, \textit{Attach transition/effect}.
363     \item[Video]  video functions such as \textit{Default/Attach transition}.
364     \item[Tracks]  move or delete tracks are the most often used.
365     \item[Settings]  this is mostly described in other sections (\ref{cha:configuration_settings_preferences}).  
366         However, \textit{typeless keyframes} are not described anywhere else.  
367         They allow keyframes from any track to be pasted on either audio or video tracks.
368     \item[View]  for display or modifying asset parameters and values to include Fade, Speed, and Cameras.
369     \item[Window]  window manipulation functions.
370 \end{description}
371
372
373 \subsection{Window Layouts}%
374 \label{sub:window_layouts}
375
376 If you like to use different window layouts than the default for certain scenarios, you can setup, save, and load 4 options.   
377 First position your Cinelerra windows where you want them to be and then use the Window pulldown and choose \emph{Save layout}.  
378 To use the default name of \textit{Layout \#}, when the popup comes up, just click the green checkmark OK on the Layout popup menu.  
379 If you would like a specific name for your layout so you can remember what it is for, keyin 1-8 english characters that are meaningful to you (english characters mean you can not use the German umlaut or the French accent).  
380 Legal characters are a-z, A-Z, 0-9, \_ (the underscore character) and a limit of 8 total.  
381 If you keyin more than 8, only the last 8 characters will be used.  
382 To rename a currently existing layout, use the Save layout option again on the one to rename, and keyin a different name into the text box or blank for the default name (figure~\ref{fig:window_layouts}).
383
384 \begin{figure}[htpb]
385     \centering
386     \begin{minipage}{.49\linewidth}
387         \center{\includegraphics[width=1\linewidth]{images/window_layout1.png}}\\ a)
388         %TODO High res image replace
389     \end{minipage}
390     \begin{minipage}{.49\linewidth}
391         \vspace{13ex}
392         \center{\includegraphics[width=1\linewidth]{images/window_layout2.png}}\\ b)
393         %TODO Alpha channel
394     \end{minipage}
395     \caption{Window Layouts}
396     \label{fig:window_layouts}
397 \end{figure}
398
399 The files containing the coordinates for your layouts will automatically be saved in the \texttt{\$HOME/.bcast5} directory as \texttt{layout\#\_rc} or \texttt{layout\#\_8chars\_rc}.
400
401 To use the desired layout, keyin the shortcut or use the Window pulldown and choose \emph{Load layout} and then make your choice. 
402
403 \subsection{Just Playing!}%
404 \label{sub:just_playing_}
405 What if you are just using Cinelerra to play media and listen to tunes? 
406 After loading your media, just hit the space bar to start playing and then again to stop playing.  
407 Other than that, use the transport buttons on the top bar of the Program window.  
408 Other ways, not previously mentioned to \textit{play around} are described next. 
409
410 \subsubsection*{Repeat Play / Looping Method}%
411 \label{ssub:repeat_play_looping_method}
412
413 There are 2 methods for repeat play or looping on the timeline and 1 method for both the Compositor and the Viewer.  This works in conjunction with any of the transport buttons or shortcuts in either forward or reverse as usual.  The 1 exception is that the Shift button can not be used to either add or subtract audio within the repeat area.
414
415 \textit{Method 1:} Shift-L on the Timeline, repeats the selection per the algorithm outlined next.
416   
417 When setup, long green lines are displayed across the entire set of tracks which shows the start and end of the loop.
418 \begin{enumerate}
419     \item  Highlighted selection repeats loop and takes precedence over all other possibilities.  
420         If the cursor is before the highlighted area, it will play up to the area and then repeat the highlighted section.  
421         If the cursor is after the highlighted section, play will start at the beginning until you get to the
422         highlighted section and then repeat.
423     \item  When both In and Out pointers are set, it repeats the section between [ and ].
424     \item  If only one of the In or Out pointers is set, it loops the whole media.
425 \end{enumerate}
426
427 \textit{Method 2:} Ctrl+Shift+transport button on the Timeline, Viewer, and Compositor
428
429 \begin{enumerate}
430     \item Repeats entire media if no In or Out pointer set.
431     \item  In and Out pointer set, repeats area between pointers.
432     \item  Only In pointer set, repeats from In to end of media.
433 \end{enumerate}
434
435 \subsubsection*{Last Play Position Memory}%
436 \label{ssub:last_play_position_memory}
437
438
439 When you play media, the start/end playback positions are saved as if they had been made into temporary labels.  
440 They appear on the timeline as purple/yellow hairline markers representing the last start/end labels for the last playback. 
441 They can be addressed as if they are label markers using:
442
443 \begin{description}
444     \item[Ctrl$\leftarrow$]   tab to the label before the cursor, that is \textit{play start}
445     \item[Ctrl$\rightarrow$]   tab to the label after the cursor, that is \textit{play stop}
446 \end{description}
447
448
449 You can use these markers for re-selection.  
450 Additionally, the selection region can be expanded by \textit{pushing} the markers using single frame playback.  
451 Use frame reverse (\texttt{keypad 4}) to push the start play marker backward, or use frame forward (\texttt{keypad 1}) to push the end play marker forward.
452
453 Another handy feature is to use the combination of Ctrl-shift-arrow (left or right) to select the media from the cursor position (red hairline) to the start or end marker by \textit{tabbing} to the label markers.  
454 For example, tab to the beginning of the previous play region using Ctrl-left-arrow to move the cursor to the beginning of last play, then press Ctrl-Shift-right-arrow to tab to the end of the playback region. 
455 Now you can clip/play/expand or edit the previous playback selection.
456
457 \begin{description}
458     \item[Ctrl SHIFT$\rightarrow$]        tab cursor to label right of cursor position and expand selection
459     \item[Ctrl SHIFT$\leftarrow$]         tab cursor to label left of cursor position and expand selection
460 \end{description}
461
462
463 \subsubsection*{Playback Speed Automation Support}%
464 \label{ssub:playback_speed_automation_support}
465
466
467 The speed automation causes the playback sampling rate to increase or decrease to a period controlled by the speed automation curve.  
468 This can make playback speed-up or slow-down according to the scaled sampling rate, as \textit{time is multiplied by speed} (Speed $\times$ Unit\_rate).
469
470 \subsubsection*{Alternative to using Numeric Keypad for Playing}%
471 \label{ssub:alternative_to_using_numeric_keypad_for_playing}
472
473
474 For the keyboards without a numeric keypad or if you prefer to use keys closer to where you normally type, there are alternative keys for the play/transport functions.  These are listed below.
475
476 \begin{tabular}{lcl}
477         Alt + m&=&stop playback\\
478
479         Alt + j&=&forward single frame\\
480
481         Alt + k&=&forward slow playback\\
482
483         Alt + l&=&forward normal playback\\
484
485         Alt + ;&=&forward fast playback\\
486
487         Alt + u&=&reverse single frame\\
488
489         Alt + i&=&reverse slow playback\\
490
491         Alt + o&=&reverse normal playback\\
492
493         Alt + p&=&reverse fast playback\\
494 \end{tabular}
495 \begin{minipage}{.45\linewidth}
496 + Shift key, results in the reverse of whether audio is included or not.
497 \vspace{1ex}
498
499 + Ctrl, results in the transport function operating only between the in/out pointers.
500 \end{minipage}
501
502 \section{Compositor Window}%
503 \label{sec:compositor_window}
504
505 The Compositor window (figure~\ref{fig:compositor_window}) displays the output of the timeline. 
506 It is the interface for most compositing operations or operations that affect the appearance of the timeline output. 
507 Operations done in the Compositor affect the timeline but do not affect clips.
508
509 \begin{figure}[htpb]
510     \centering
511     \includegraphics[width=0.99\linewidth]{images/compositor_window.png}
512     \caption{Upper right side contains navigation tools / bottom bar has manu control functions}
513     \label{fig:compositor_window}
514 \end{figure}
515
516 \subsection{Compositor controls}%
517 \label{sub:compositor_controls}
518
519
520 Navigating the video output does not affect the rendered output; it just changes the point of view in the compositor window. 
521 The video output has several navigation functions. 
522 The video output size is either locked to the window size or unlocked with scrollbars for navigation. 
523 The video output can be zoomed in and out and panned. 
524 If it is unlocked from the window size, middle clicking and dragging anywhere in the video pans the point of view. Hitting the + and -- keys zooms in and out of the video output.
525
526 Underneath the video output are copies of many of the functions available in the main window. 
527 In addition there is a zoom menu and a tally light. 
528 The zoom menu jumps to all the possible zoom settings and, through the Auto option, locks the video to the window size. 
529 The zoom menu does not affect the window size. 
530 The tally light turns red when rendering is happening. This is useful for knowing if the output is current. 
531 Right clicking anywhere in the video output brings up a menu with all the zoom levels, zoom auto mode, and some other options. 
532 In this particular case the zoom levels resize the entire window and not just the video. 
533 The \emph{Reset camera} and \emph{Reset projector} options center the camera and projector. 
534 The \emph{Hide controls} option hides everything except the video. 
535
536 On the left of the video output is a toolbar specific to the compositor window. The toolbar has the following functions:
537
538 \emph{Protect video} --- disables changes to the compositor output from clicks in it. It is an extra layer on top of the track arming toggle to prevent unwanted changes.
539
540 \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.
541
542 \begin{description}
543     \item[Left clicking] in the video zooms in;
544     \item[Ctrl clicking] in the video zooms out;
545     \item[Rotating the wheel] on a wheel mouse zooms in and out.
546 \end{description}
547
548 In addition, if you enable the Magnifying glass, a zoom slider for fine-viewing appears below these tools.  
549 It allows you to zoom to most any size. 
550 A \textit{zoom slider} will pop-up towards the bottom on the left-hand side of the Compositor when you enable \textit{Zoom view} via the magnifying glass or when you click on the icons for \textit{Adjust camera automation} or \textit{Adjust projector automation}.  
551 This will allow for adjusting the amount of zoom at any level between 0.01 and 100 based on a logarithmic scale.  
552 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.  
553 The zoom slider size is in the form of \textit{times}, such as $\times$0.82 which indicates that the picture is zoomed to $\frac{82}{100}^{th}$ of the original size as seen in \texttt{Settings $\rightarrow$ Format}.  
554 Once you have set the zoom to the desired size, use the vertical and horizontal scroll bars to position the view as needed.
555
556 Screencast (figure~\ref{fig:zoom_slider}) shows below at a zoom slider bar with the diamond shaped slider in the middle.  Note 
557 that the magnifying glass is  enabled which automatically pops-up the slider.
558
559 \begin{figure}[htpb]
560     \centering
561     \includegraphics[width=0.99\linewidth]{images/zoom_slider.png}
562     \caption{A zoom slider bar with the diamond shaped slider in the middle}
563     \label{fig:zoom_slider}
564 \end{figure}
565 The Format shows a large $5204\times3468$ video and the box at the arrow shows $\times0.82$ size.  
566
567 \begin{description}
568     \item[Masks tool] this tool brings up the mask editing tool. Enable \textit{Show tool info} to see the options.
569     \item[Camera]  the camera brings up the camera editing tool. Enable \textit{Show tool info} to see options.
570     \item[Projector]  the projector brings up the projector editing tool. Enable \textit{Show tool info} for options.
571     \item[Crop tool]  this tool brings up the cropping tool. \textit{Show tool info} must be enabled to use this tool.
572     \item[Eyedropper]  brings up the eyedropper. The eyedropper detects whatever color is under it and stores it
573         in a temporary area. Enabling the \textit{Show tool info} shows the currently selected color. Click
574         anywhere in the video output to select the color at that point. The eyedropper not only lets you see
575         areas which are clipped, but its value can be applied to many effects. Different effects handle the
576         eyedropper differently.
577     \item[Show tool info]  this tool button works only in conjunction with the other controls on the compositor.
578         Based on what compositing control is active, the toggle button will activate or deactivate the
579         appropriate control dialog box. Controls with dialog boxes are: Edit mask, Camera and Projector
580         automation, Crop control, and Get color.
581     \item[Safe regions tool]  draws the safe regions in the video output. The largest (external) square is called \textit{action safe overlay}; the smallest internal square is called \textit{title safe overlay}. They are especially useful if the destination is the TV. This does not affect the rendered output
582 \end{description}
583
584 \subsection{Compositing}%
585 \label{sub:compositing}
586
587 A large amount of Cinelerra's editing is directed towards compositing. 
588 Changing the resolution of a show, making a split screen, and fading in and out among other things are all compositing operations in Cinelerra. 
589 Cinelerra detects when it is in a compositing operation and plays back through the compositing engine only then. 
590 Otherwise, it uses the fastest decoder available in the hardware.
591
592 Compositing operations are done on the timeline and in the Compositor window. Shortcuts exist in the Resource window for changing some compositing attributes. 
593 Once some video files are on the timeline, the compositor window is a good place to try compositing.
594
595 \subsection{Camera and Projector}%
596 \label{sub:camera_and_projector}
597
598 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. 
599 Cinelerra's compositing routines use a \textit{temporary}, a frame of video in memory where all graphics processing is performed. 
600 Inside Cinelerra's compositing pipeline, the camera determines where in the source video the \textit{temporary} is copied from. 
601 The projector determines where in the output the \textit{temporary} is copied to (figure~\ref{fig:temporary-01}). 
602 Each track has a different \textit{temporary} which is defined by the track size. By resizing the tracks you can create split screens, pans, and zooms.
603
604 \begin{figure}[htpb]
605     \centering
606     \includegraphics[width=0.8\linewidth]{images/temporary-01.pdf}
607     \caption{Compositing pipeline}
608     \label{fig:temporary-01}
609 \end{figure}
610
611 In compositing, each frame can be digitally altered using various options, such as a color correction plugin (figure~\ref{fig:camera_and_projector}). 
612 Once the image has been transformed, the finished image is then projected to the compositor thus creating a modified version of the original.
613
614 \begin{figure}[htpb]
615     \centering
616     \includegraphics[width=0.8\linewidth]{images/camera_and_projector.png}
617     \caption{Color balance on Temporary}
618     \label{fig:camera_and_projector}
619 \end{figure}
620
621 When editing the camera and projector in the compositing window, the first track with record enabled is the track affected. 
622 Even if the track is completely transparent, it is still the affected track. 
623 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. 
624 This solos the track.
625
626 The purpose of the projector is to place the contents of the \textit{temporary} into the project's output.  
627 The intent of the projector is to composite several sources from the various tracks into one final output track. 
628 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.
629
630 \subsubsection*{Compositing projector controls}%
631 \label{ssub:compositing_projector_controls}
632
633 When the projector button is enabled in the compositor window, you are in projector editing mode. A guide box appears in the video window. The red box indicates the size of the frame that will be sent to the Ouput. You can drag the box with LMB, moving the frame in $x$ and $y$ as you like. Even when moving along the $z-axis$ (i.e. the zoom, with SHIFT+Drag) the red box faithfully follows the movement and size of the frame. Once you have positioned the video with the projector, you may want to work with adjusting the camera automation.
634
635 \subsubsection*{Viewport sizes}%
636 \label{ssub:viewport_sizes}
637
638 The viewport is a window on the camera that frames the area of source video to be scanned.
639 The initial size of the viewport is defined by the size of the current track. A smaller viewport ($640\times400$) captures a smaller area. 
640 A larger viewport ($800\times200$) captures an area larger than the source video and fills the empty spaces with blanks. 
641 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:
642
643 \begin{enumerate}
644     \item  Open the compositor window with a track selected.
645     \item  Select the camera button to enable camera editing mode.
646     \item  Drag over the display window.
647 \end{enumerate}
648
649 When we drag over the viewport in the compositor window, the way it looks is as if you \textit{move the camera with the mouse}.  The viewport also moves with it.
650
651 \subsubsection*{Compositing camera controls}%
652 \label{ssub:compositing_camera_controls}
653
654 Select the camera button to enable camera editing mode. 
655 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. 
656 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.
657
658 \subsubsection*{The camera and projector tool window}%
659 \label{ssub:the_camera_and_projector_tool_window}
660
661 The camera and projector have shortcut operations that do not appear in the popup menu and are not represented in video overlays. 
662 These are accessed in the \emph{Show tool info} window . 
663 Most operations in the Compositor window have a tool window which is enabled by activating the question mark icon (figure~\ref{fig:camera_tool}).
664
665 \begin{wrapfigure}[12]{O}{0.3\linewidth} 
666         \vspace{-2ex}
667     \includegraphics[width=0.9\linewidth]{images/camera_tool.png}
668     \caption{Camera and Projector tool}
669     \label{fig:camera_tool}
670 \end{wrapfigure}
671
672 In the case of the camera and projector, the tool window shows $x$, $y$, and $z$ coordinates. 
673 By either tumbling or entering text directly, the camera and projector can be precisely positioned.  
674 Justification types are also defined for easy access. 
675 A popular justification operation is upper left projection after image reduction. 
676 This is used when reducing the size of video with aspect ratio adjustment.  
677 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.
678
679 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. 
680 The track size is set to the original size of the video and the camera is centered. 
681 The output size is set to the reduced size of the video. 
682 Without any effects, this produces just the cropped center portion of the video in the output.
683
684 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. 
685 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. 
686 Instead, we leave out $x$ and out $y$ at 0 and use the projector's tool window. 
687 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.
688
689 \subsubsection*{Reset to Default}%
690 \label{ssub:reset_default}
691
692 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:
693
694 \textit{Reset Camera}: causes the camera to return to the center position.
695         
696 \textit{Reset Projector}: causes the projector to return to the center.
697
698 \subsubsection*{Use Case: Interaction Between Camera And Projector \protect\footnote{Example provided by Sam. The relative video is located at: \url{https://streamable.com/iq08i}}}%
699 \label{ssub:use_case_interaction_camera_projector}
700
701 \begin{enumerate}
702     \item Start by shrinking the projector to $z=0,500$ ($\frac{1}{4}$ of the original frame).
703     \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.
704     \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.
705     \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.
706     \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.
707 \end{enumerate}
708
709 \subsection{Masks}%
710 \label{sub:masks}
711
712 Masks select a region of the video for either displaying or hiding. 
713 Masks are also used in conjunction with another effect to isolate the effect to a certain region of the frame. 
714 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. 
715 Color correction may be needed in one subsection of a frame but not another. 
716 A mask can be applied to just a subsection of the color corrected track while the plain track shows through. 
717 Removal of boom microphones and airplanes are a common kind of mask uses.
718
719 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.
720
721 The compositing pipeline graph has a masking stage (figure~\ref{fig:temporary-02}).
722
723 \begin{figure}[htpb]
724     \centering
725     \includegraphics[width=0.7\linewidth]{images/temporary-02.pdf}
726     \caption{compositing pipeline with mask}
727     \label{fig:temporary-02}
728 \end{figure}
729
730 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.
731
732 \subsubsection*{Compositing pipeline with masks}%
733 \label{ssub:compositing_pipeline_with_masks}
734
735 \begin{enumerate}
736     \item To define a mask, go into the Compositor window and enable the mask toggle.
737     \item  Next go over the video and click-drag. 
738         Note: You have to select automatic keyframes if you wish to move a mask over time.  
739         If you do not, the mask position will be the same even if you edit at different places on the timeline.
740     \item  Click-drag again in another part of the image to create each new point of the mask. 
741         While it is not the conventional Bezier curve behavior, this masking interface performs in realtime what the effect 
742         of the mask is going to be. Creating each point of the mask expands a rubber band curve.
743
744         Once points are defined, they can be moved by Ctrl-dragging in the vicinity of the corner. 
745         Shift-drag allows you to move existing points to new locations, thus altering the shape of the mask.  
746         However, this does not smooth out the curve. 
747         The end points of the Bezier curve are accessed by Ctrl-dragging in the vicinity of the corner. 
748         Then Ctrl-dragging near the end point causes the point to move.  
749         Shift-drag activates bezier handles (control points) to create curves between mask points.       
750
751     \item  Finally once you have a mask, the mask can be translated in one piece by Alt-dragging the mask.
752     The effect of the mask is always on.  
753     Ctrl-Alt-drag translates an entire mask to a new location on the
754     screen.
755 \end{enumerate}
756
757 The masks have many more parameters which could not be represented with video overlays. 
758 These are represented in the tool window for masks. 
759 Selecting the question mark when the mask toggle is highlighted brings up the mask options window (figure~\ref{fig:mask_window}).
760
761 \begin{figure}[htpb]
762     \centering
763     \includegraphics[width=0.5\linewidth]{images/mask_window.png}
764     \caption{Mask options window}
765     \label{fig:mask_window}
766 \end{figure}
767
768 Masking has been greatly improved compared to the original tool.  Detailed description is provided here.  Note that the Mask window is separated into various sections to make it easier to locate the area of interest.
769
770 \subsubsection*{Masks on Track section}%
771 \label{ssub:masks_track_section}
772
773 The \textit{Track}: textbox displays the different video tracks for your session which will be initially set to the first armed video track or will be left blank if there are no armed tracks.  A pulldown to the right of the box brings up the names of all of the video tracks allowing you to change to which track the masking applies.  You can also just use the tumbler to easily mouse up/down to get to the desired track. In the pulldown list, any track that has red colored text is disarmed so that you can not change it.  A track that contains masks has yellow colored text for easy identification.  Only when there are no masks on the track, do you have the default text color. This textbox is display only and you can not type into it.
774
775 The \textit{Solo} button in the Masks on Track section of the Mask window is very handy when working with masks on different tracks.  It displays only that track so that you only see the track you choose, as well as the tracks behind it to show the mask part.  The Solo button is just a convenience to prevent having to mouse over to the patchbay.
776
777 \subsubsection*{Masks section}%
778 \label{ssub:masks_section}
779
780 The \textit{Mask}: textbox will show you the mask numbers of $0-7$ or the 8 ascii character name that you have used to designate each mask number.  There is a pulldown on the right side to easily switch to another mask. 
781
782 The \textit{Delete} button is used to delete the mask number/name that is selected. The symbol to the right with tooltip of \textit{Delete all masks} can be used to delete all of the current video track masks.
783
784 The \textit{Select}: row of checkboxes is used to indicate which mask is currently displayed for that video track in the Compositor.  Numbers that are colored yellow are active masks for that track.  A tumbler to the right allows for quickly changing the mask number displayed.
785
786 The \textit{Enable} row of masks makes it so you can enable all or none of the masks, making it possible to look at no masks or at one mask without interference from the other masks. The symbol that looks like an \texttt{eye} can be used to easily check all or none as the tooltip \textit{Show/Hide mask states}.
787
788 \subsubsection*{Preset Shapes section}%
789 \label{ssub:preset_shape_section}
790
791 There are 4 shapes that are automatically available for usage as masks – square, circle, triangle, and oval.  In addition, the next 3 symbols in this section are for the purpose of loading, saving, and deleting your own customized shapes.  The first symbol, \textit{Load} preset, will bring up a list of your previously saved presets.  Clicking on \textit{Save} preset brings up a popup window allowing you to provide a name used to identify the preset you want to save, along with a pulldown to see the names of your other saved presets.   Clicking on \textit{Delete} preset also brings up a textbox with a pulldown to choose which one to delete.  There is a file, called \texttt{mask\_rc}, in \texttt{\$HOME/.bcast5} that records your custom masks.  
792
793 When you click \textit{Load} preset, keep in mind that it will write the mask number that you have selected so if you already have a mask at that location, it will write over it – just UNDO to revert to the previous if you made this mistake.
794
795 \subsubsection*{Position \& Scale section}%
796 \label{ssub:position_scale_section}
797
798 \textit{Center} mask button allows for quickly centering a mask on the video track. 
799 \textit{Normalize} mask button makes it easy to normalize the size of the mask based on the scale of the video. 
800 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.
801
802 \texttt{xlate/scale x}  - drag translate constrained in the $X$ direction
803
804 \texttt{xlate/scale y}  - drag translate constrained in the $Y$ direction
805
806 \texttt{xlate/scale x/y}        - drag translate in both directions; this is the default and after using the other 2 options, you should reset to this to avoid future confusion while dragging.
807
808 \subsubsection*{Fade \& Feather section}%
809 \label{ssub:fade_feather_section}
810
811 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. 
812
813 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:
814
815 Note1: The area outside the mask is referred to as the background.
816
817 Note2: The operational result is based on the maximum transparency value of that background.
818
819 \paragraph{Case 1, Positive Fade:} When the fade for all of the masks is positive, affecting the area inside of the mask, all of the
820 background colors are at a transparency value of zero. So the largest transparency value is 0,and all masks are drawn with opaque backgrounds, depicted as one would expect.
821
822 \paragraph{Case 2, Negative Fade:} When the program computes the background color for any number of masks that includes negative
823 mask(s), it uses the largest transparency number as the determining factor for the background. Only 1 of the masks can be largest, and wins for the background transparency result.
824
825 \vspace{3ex}\textit{Feather}: works in a similar manner to a \textit{gradient Fade} aligned on the mask boundary but is a logical function instead of a mathematical function so will be faster.  The \textit{Gang feather} symbol also works in a similar fashion and is surrounded by a gold colored background when it is in effect.
826
827 \subsubsection*{Mask Points section}%
828 \label{ssub:masks_points_section}
829
830 This section is used to change to a different mask number and manipulate the masks you have created.
831
832 The \textit{Point}: textbox provides the ability to change which point number for the current mask that you want to work on.  It has a tumbler to allow for quickly switching the point number.  The \textit{X:} and \textit{Y:} boxes below reflect the current values and allow for modifying the $X/Y$ coordinates and these too have tumblers. The \textit{Delete} button will allow for deleting the selected point number.
833
834 The next 6 symbols in 2 columns represent \textit{Smooth} and \textit{Linear} buttons.  Smooth buttons use an algorithm based on the previous point and the next point to create a curved line. The smoothing operation takes three points, A, B, C, and arranges the slope at B to be AC as it moves to the next point for that mask.
835
836 \textit{smooth point}   $\rightarrow$ smooth a single point.
837
838 \textit{smooth curve}   $\rightarrow$ smooth all points on a mask edge curve.
839
840 \textit{smooth all}     $\rightarrow$ smooth all active masks.
841
842 Linear buttons of \textit{linear point}, \textit{linear curve}, and \textit{linear all}, perform the inverse of the smooth functions.
843 The control point vectors on the bezier endpoints are set to zero magnitude.
844
845 In addition there is a \textit{Markers} and a \textit{Boundary} checkbox which come in handy to turn off the display of the points and the outline of the mask.  Turning off \textit{Markers} is very useful when you have a lot of control points that clutter the display and make it more difficult to see the actual mask.  A helpful feature is available by disabling \textit{Markers} and enabling \textit{Boundary} which results in all masks being displayed in the viewer; for example you can then see mask 0, mask 1 \dots at the same time.
846
847 A \textit{gang} symbol on the right hand side of this section, tooltip of \textit{Gang points}, is another useful feature that makes it easy to drag a mask to an exact coordinate using the \textit{X} or \textit{Y} textbox for numerical input or the associated tumblers.  This works like the \texttt{Alt+LMB drag} translate but provides the ability to be precise.
848
849 \subsubsection*{Pivot Point section}%
850 \label{ssub:pivot_point_section}
851
852 The \textit{X:} and \textit{Y:} coordinates mark the value of the current \textit{Pivot Point} used for rotation, scaling, and translation.  You can either directly key in numerical values or use the tumblers to change the values as long as the \textit{Focus} checkbox is checked.
853
854 The \textit{Focus} checkbox is used in case you want to set a different point in the Compositor for pivoting instead.  And the \textit{Gang} symbol for rotate/scale/translate means that these operations will be performed on all points of the enabled masks.  The gang symbol is surrounded by a gold colored background when it is in effect.  When performing a rotate operation on a mask with the mouse wheel, \textit{acceleration} is in effect -- this means the faster you wheel, the more space is covered so that you do not have to wheel dozens of time to make a full rotation.  Then when you wheel around slower, you can fine tune the result.
855
856 \subsubsection*{Other sections}%
857 \label{ssub:other_sections}
858
859 Finally there are the \textit{Apply masks before plugins} and \textit{Disable OpenGL masking} self-explanatory checkboxes.
860
861 Note: Not all OpenGL software can support the current masking methods.  If your opengl implementation does not support Shader Version 4.3 or has trouble with this (it is relatively new to opengl at the time this was implemented), then this checkbox will allow you to use the software masking to avoid any potential issues.  Normally, a OpenGL is probed for the shader version and will automatically use the software implementation if required.
862
863 The \textit{Help} checkbox can be enabled in order to see a list of the keys used to perform various operations.  If you use Masking infrequently, these are a valuable reminder to which key combinations to use.  Currently they are as follows:
864
865 \vspace{2ex}
866 \begin{tabular}{ l  l }
867     \hline                      
868     Shift+LMB & move an end point \\
869     Ctrl+LMB & move a control point \\
870     Alt+LMB & to drag translate the mask \\
871     Shift+MMB & set Pivot Point at pointer \\
872     Wheel & rotate around Pivot Point \\
873     Ctrl+Shift+Wheel & scale around Pivot Point \\
874     Ctrl+Wheel & rotate/scale around pointer \\
875     \hline  
876 \end{tabular}
877
878 \vspace{2ex} Note: For some desktop window managers, certain keys may already be in use by the operating system, so you will either have to redefine them in your desktop or use different key combinations.  For example, at least some desktops used with \textit{UbuntuStudio 16.04} and \textit{Arch} field the \texttt{Alt} key, thus requiring alternative key combinations to be needed.  Below are some of these alternatives.
879
880 \vspace{2ex}
881 \begin{tabular}{ l p{11cm}}
882     \hline                      
883     LMB & move/create an end point (to move the end point the pointer must be above the point) \\
884     Shift+LMB & move an end point (the pointer may be near the point, not above it) \\
885     Ctrl+LMB & move/create a control point \\
886     Alt+Ctrl+LMB & to drag translate the mask \\
887     Shift+Key Delete & to delete the mask \\
888     Shift+MMB & Set Pivot Point at pointer \\
889     Alt+Wheel & zoom in/out the screen (also available in Ubuntu16 but does not exist in all distros) \\
890     \hline  
891 \end{tabular}
892
893 \vspace{2ex}
894 Focus checkbox = unchecked:
895
896 \vspace{2ex}
897 \begin{tabular}{ l  l }
898     \hline                      
899     Wheel & rotate around Pivot Point \\
900     Shift+Wheel & scale around Pivot Point \\
901     Ctrl+Wheel & rotate around pointer \\
902     Ctrl+Shift+Wheel & scale around pointer \\
903     
904     \hline  
905 \end{tabular}
906
907 \vspace{2ex}
908 Focus checkbox = checked:
909
910 \vspace{2ex}
911 \begin{tabular}{ l  l }
912     \hline                      
913     Wheel & rotate around Pivot Point (“Custom focus point”) \\
914     Shift+Wheel & scale around Pivot Point (“Custom focus point”) \\       
915     \hline  
916 \end{tabular}
917
918 \vspace{2ex}
919 Note: in order to be able to rotate/scale around pointer, the Focus checkbox must be unchecked.
920
921 \subsection{Cropping}%
922 \label{sub:cropping}
923
924 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. 
925
926 \begin{figure}[htpb]
927     \centering
928     \includegraphics[width=0.5\linewidth]{images/cropped_area.png}
929     \caption{Cropped area is in the top right corner}
930     \label{fig:cropped_area}
931 \end{figure}
932
933 \begin{itemize}
934     \item Enable the crop toggle and the tool window in the compositor window to display the Crop control dialog box.
935     \item Click-drag anywhere in the video to define the crop area. This draws a rectangle over the video.
936     \item Click-drag anywhere in the video to start a new rectangle.
937     \item Click-drag over any corner of the rectangle to reposition the corner.
938     \item Alt-click in the cropping rectangle to translate the rectangle to any position without resizing it.
939     \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.
940     \item The \textit{Set Format} window will show the new project Width and Height values.
941     \item The projector tool window will show the new $X, Y$ values.
942     \item Track size will remain unchanged.
943 \end{itemize}
944  
945 To undo the cropping enter the original project dimensions in the \textit{Set Format} window and click on \textit{Reset projector} in the popup menu of the compositor.
946
947 \subsection{Safe Regions}%
948 \label{sub:safe_regions}
949
950 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. 
951 The borders are intended for scratch room and vertical blanking data. 
952 You can show where these borders are by enabling the safe regions toggle. 
953 Keep titles inside the inner rectangle and keep action inside the outer rectangle.
954
955 \begin{figure}[htpb]
956     \centering
957     \includegraphics[width=0.5\linewidth]{images/safe_regions.png}
958     \caption{Note the black frames showing the safe regions}
959     \label{fig:safe_regions}
960 \end{figure}
961
962 \subsection{Track and Output Sizes}%
963 \label{sub:track_and_output_sizes}
964
965
966 The size of the temporary and the size of the output in our compositing pipeline are independent and variable. 
967 The camera's viewport is the temporary size. 
968 Effects are processed in the temporary and are affected by the temporary size. 
969 Projectors are rendered to the output and are affected by the output size. 
970 If the temporary is smaller than the output, the temporary is bordered by blank regions in the output. 
971 If the temporary is bigger than the output, the temporary is cropped.
972
973 \subsubsection*{Track size}%
974 \label{ssub:track_size}
975
976 The temporary size is defined as the track size. 
977 Each track has a different size. 
978 Right click on a track to bring up the track's menu. 
979 Select \emph{Resize Track} to resize the track to any arbitrary size. 
980 Alternatively you can select \emph{Match output size} to make the track the same size as the output. 
981 If you resize a track, then its appearance on the compositor changes accordingly. 
982 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.
983
984 \subsubsection*{Output size}%
985 \label{ssub:output_size}
986
987
988 The output size is set in either \texttt{File $\rightarrow$ New} when creating a new project or \texttt{Settings $\rightarrow$ Format}. 
989 In the Resources window there is another way to change the output size. 
990 Right click on a video asset and select \emph{Match project size} to conform the output to the asset. 
991 When new tracks are created, the track size always conforms to the output size specified by these methods.
992
993 When rendering, the project's output size is the final video track size where the temporary pipeline is rendered into.  
994 If the output size is larger than the temporary then the image transferred from the temporary will fit inside the Output Track. 
995 Any space left on the Output is left blank.  
996 If the output size is smaller than the temporary then some of the temporary video will be cropped.
997
998 \section{Viewer Window}%
999 \label{sec:viewer_window}
1000
1001 The viewer window (figure~\ref{fig:viewer_window}) is a place to load and preview your source media and clips.  
1002 Here you can quickly browse through an asset using the slider control, focus on an area of work with the preview region or you use editing controls to cut and paste segments into the project or create a clip for later use.
1003
1004 \begin{figure}[htpb]
1005     \centering
1006     \includegraphics[width=0.99\linewidth]{images/viewer_window.png}
1007     \caption{Viewer Window}
1008     \label{fig:viewer_window}
1009 \end{figure}
1010
1011 To open the viewer window, go to \texttt{Window $\rightarrow$ Show Viewer}.  
1012 The display is the area on the viewer where you actually see media playing.  
1013 Before you can play any media, you must first load it on the viewer. 
1014 To load media into the viewer:
1015
1016 \begin{enumerate}
1017     \item  Open the resources manager window and select the Media folder or the Clip folder.
1018     \item  Drag a file from the Media or the Clip folder to the viewer.
1019 \end{enumerate}
1020
1021 You can also load media onto the viewer by right clicking on a file in the asset manager and selecting View from the popup menu or by double clicking on the icon. 
1022 Once your media loads you will see it appear on the display. 
1023 To play, rewind or forward through it use the slider control or the transport controls. 
1024 You can change the media display size by right clicking on the screen to activate the display zoom menu. 
1025 Select zoom levels of 50\%, 100\% or 200\% of the original media size.
1026
1027 When displaying media, the viewer uses the project's defined output size format settings, not the original assets format. 
1028 You can change the project's output to match the asset's format using the match project size menu option in the asset manager. 
1029 In the Viewer you can move around in the source media or clips and select regions to paste into the project. 
1030 Operations done in the viewer affect a temporary EDL or a clip, but not the timeline.
1031
1032 \section{Options in both the Compositor and Viewer Windows}%
1033 \label{sec:options_in_both_the_compositor_and_viewer_windows}
1034
1035 The next sections describe capabilities that are available in both the Compositor and Viewer windows.
1036
1037 \subsection{Click to Play in Viewer and Compositor}%
1038 \label{sub:click_to_play_in_viewer_and_compositor}
1039
1040 In both the Viewer and Compositor windows, there is an arrow on the right hand side of the other buttons in the edit panel.  
1041 Mouse action can be toggled on/off via this arrow, which has a tooltip of \textit{Click to play} with the letter "\texttt{P}" to be used for a shortcut.  
1042 When enabled there is a gold-colored shadow around the usual green-colored arrow.  
1043 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.  
1044 The entire main canvas surface becomes a big play button!  
1045 Although the default is initially off, a good reason to enable this, at least temporarily, is so that you can quickly review your video before a render. 
1046  
1047 \begin{description}
1048     \item[left click]          forward play or stop forward play if already playing
1049     \item[middle wheel]  single frame forward or back
1050     \item[middle click]    reverse play or stop reverse play if already playing. 
1051         Note that some 3 button mice do not accommodate a middle click for reverse but you can find out by testing from a terminal window with the command \texttt{xev}.
1052 \end{description}
1053
1054 \subsection{Timebar + Preview Region Usage in the Compositor and Viewer}%
1055 \label{sub:timebar_preview_region_usage_in_the_compositor_and_viewer}
1056
1057 The navigation features of the Viewer and Compositor behave very similarly. 
1058 Each has a timebar and slider below the video output. 
1059 The timebar represents the entire time covered by the program.   
1060 When you have a file loaded in the main window and then slide around it using the compositor slider. The insertion point in the main window follows the compositor. 
1061
1062 Labels and In/Out points are fully supported in the viewer and compositor.  
1063 In the viewer and compositor, labels and in/out points are displayed in the timebar.  
1064 But there is a difference between the viewer and compositor in that the compositor reflects the state of the program while the viewer reflects the state of a clip but not the program. 
1065 When you hit the label button in the compositor, the label appears both in the compositor timebar and the program timebar. 
1066 When you select a label or in/out point in the compositor, the insertion point in the program window jumps to that position. 
1067
1068 The timebar in the compositor and the viewer can be used to define a region known as the \textit{preview region}.  
1069 This preview region is the region of the timeline which the slider affects.  
1070 By using a preview region inside the entire program and using the slider inside the preview region you can very precisely and relatively quickly seek in the compositor and viewer.  
1071 The preview region can be especially handy when you have large pieces of media by previewing one section, then move to the next section.  
1072
1073 The active preview region is the zone between the edge bars.  
1074 The full range of the window slider pointer action is down-scaled to the active preview region.   
1075 To use this, set the preview active region as a media time region of interest.  
1076 Now addressing the timebar with the mouse only operates as if the timebar is zoomed to the scale of the active preview zone.  
1077 This has the effect of magnifying the interesting media in terms of the mouse pointer addressing, for fine-tuning.
1078
1079 \begin{figure}[htpb]
1080     \centering
1081     \includegraphics[width=0.8\linewidth]{images/timebar1.png}
1082     \caption{The arrow above the green colored “play forward” transport button is on the timebar.}
1083     \label{fig:timebar1}
1084 \end{figure}
1085
1086 To create and use a preview region, hold down the right mouse button inside the timebar on either end of the timebar close to the edge until you see the resize pointer.  
1087 While continuously holding the right mouse button down, drag the arrow away from the end towards the middle of the timebar until you have the desired area outlined.  
1088 The slider will be a light blue color while the selected preview region will remain the same initial black color.  
1089 There are either a left or right resize pointer and you can click and drag in either direction to expand or shrink the region.
1090
1091 \begin{figure}[htpb]
1092     \centering
1093     \includegraphics[width=0.8\linewidth]{images/timebar2.png}
1094     \caption{ A left-facing arrow on the right side of the blue slider bar is used to drag the bar.}
1095     \label{fig:timebar2}
1096 \end{figure}
1097
1098 \begin{figure}[htpb]
1099     \centering
1100     \includegraphics[width=0.8\linewidth]{images/timebar3.png}
1101     \caption{Here you can see the right-facing arrow used to drag the other end of the slider bar.  
1102         The black area between is the actual preview area.}
1103     \label{fig:timebar3}
1104 \end{figure}
1105
1106 You can slide the preview zone left or right by holding the right mouse button over the preview zone where you will see a fat double headed arrow.  
1107 The selected area will move left or right as you drag and still retains the same size.
1108
1109 \begin{figure}[htpb]
1110     \centering
1111     \includegraphics[width=0.8\linewidth]{images/timebar4.png}
1112     \caption{Note the double-headed fat arrow in the preview area used  to move the selection over.}
1113     \label{fig:timebar4}
1114 \end{figure}
1115
1116 Settings:
1117
1118 \begin{enumerate}
1119     \item  If no preview region is set, increasing the length of the media on the timeline by inserting media or
1120         appending, has no effect on the non-selected preview region.  That is, you will not see the blue slider
1121         suddenly mysteriously appear.
1122     \item  If the preview region is set, when you replace the current project or file,  the preview region is
1123         automatically disabled.
1124     \item  If the preview region is set, when you append data or change the size of the current project, the
1125         preview region may appear to either move, shrink, or grow depending on the new length of the
1126         media on the timeline.  
1127     \item  To disable the preview region, you will have to drag both the right and the left blue slider bars
1128         completely to their corresponding end so that there is no longer any visible blue slider.
1129 \end{enumerate}
1130
1131 A good method for taking advantage of the preview region is described here.  
1132 On the main track canvas, scroll to the beginning of the area of interest.  
1133 When you do that, you will see in the compositor the red indicator line of that location.  
1134 Now in the compositor window, right mouse drag from the left side of the edge of the timebar to create the blue slider bar line up to the red indicator.  
1135 Back in the main track canvas, move to the location of the area you want to end looking and again you will see the red indicator line in the compositor.  
1136 Use the right mouse drag from the right to stop at that end point.  Using this method is often easier than continuous usage of the single frame move which can be tedious.
1137
1138 One last interesting item of note -- sometimes you may wish to see just a little more that is outside the preview region and you can do so!  You can actually move outside the compositor or viewer window space and view more, at least until you hit the end of the monitor space.
1139
1140 \section{Resources Window}%
1141 \label{sec:resources_window}
1142
1143 Effects, transitions, labels, clips, proxies, user bins, and media assets are accessed here. 
1144 Most of the resources are inserted into the project by dragging them out of the resource window. 
1145 Management of resource allocation is also performed here.
1146
1147 \begin{figure}[htpb]
1148     \centering
1149     \includegraphics[width=0.7\linewidth]{images/resource_window.png}
1150     \caption{Folders are in the first column with contents of that folder on the right hand side}
1151     \label{fig:resource_window}
1152 \end{figure}
1153
1154 The resources window is divided into two areas (figure~\ref{fig:resource_window}. 
1155 One area lists folders and another area lists the folder contents. 
1156 Going into the folder list and clicking on a folder updates the contents area with the contents of that folder. 
1157 The folders can be displayed as icons or text. 
1158 There are several variations for displaying the contents; select \emph{Display text}, \emph{Display icons}, \emph{Display icons packed}, \emph{Display icons list} as types of display for the assets or plugins. 
1159 Use the letter “\texttt{V}” to easily scroll through the choices and see which you prefer.  
1160 You can also get to these options from the menu by a right mouse click in the window.
1161
1162 A \emph{Search} option is available for any of the folders in the Resources window (and when using \textit{Attach effect} on the main track canvas for the Plugins).  
1163 As you type in characters a match is made with that substring.  
1164 Names that do not match are filtered out making it a lot easier to find the item you are looking for.  
1165 The characters can be any where within the phrase and it does not matter if upper or lower case. 
1166
1167 Other options you will see if you \textit{right mouse click in the folder} which brings up the menu are described next.  
1168
1169 \begin{description}
1170     \item[ Load files ]  for convenience to load files same as from the main window so you do not have to move the mouse so far in case you have multiple monitors.
1171     \item[Display text/icons]  as described previously for format variations preference.
1172     \item[Select]  options are All, Used, Unused, and None.  This gives you the capability to have a set of the
1173         contents highlighted for ease of use so you can see what is or is not loaded, or unset the highlight.
1174     \item[Sort items]  to sort the contents of the folder alphabetically.  Especially helpful if you accidentally did a 
1175         drag and changed your mind or dropped suddenly so that the assets no longer look nicely aligned.
1176     \item[Copy/Paste file list]  use to easily copy a set of files or paste a set of files between Cin and windows.
1177     \item[Snapshot/Grabshot]  described elsewhere in more detail.
1178 \end{description}
1179
1180 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.
1181
1182 If you \textit{right mouse click on a highlighted/selected resource}, several options are available depending on whether the resource is an effect or transition or a piece of media.  
1183 You can highlight several for some options so that it is applicable to all of them, such as Info.  
1184 Those listed immediately below are the available choices for media assets.
1185
1186
1187 \begin{description}
1188     \item[Info]  provided basic Asset information; details are described later in this section.
1189     \item[Display text/icons]  same as mentioned previously.
1190     \item[Sort]  same as mentioned previously.
1191     \item[Rebuild index] if you switch from/to using ffmpeg/native for media loading, you should rebuild
1192         indexes.  Or if you get hangs on media or strange looking tracks, you might want to rebuild indexes.
1193     \item[View]  use this option to bring up the media in the Viewer window.
1194     \item[View in new window]  in order to not overwrite your current viewer window, you can open any
1195         number of viewer windows to simultaneously view multiple media.
1196     \item[Open mixers]  when you record with multiple cameras setup, you can work with them most easily
1197         using the mixer mode.  This is described in detail
1198     \item[Paste]  
1199     \item[Match]  if you need to change your media parameters you can choose from the following: Match frame
1200         rate, Match project size, Match all 
1201     \item[Remove]  use to Remove the asset from the project or with caution, to Remove from disk permanently.
1202 \end{description}
1203
1204 In the case of Effects or Transitions, a right mouse click on a highlighted selection leads to an \emph{Info} button which gives a short 1 line description of what the effect/transition can be used for.
1205 For Labels, choices are \emph{Edit}, \emph{Label}, and \emph{Go to}.
1206 For Clips, \emph{Nest} and \emph{UnNest} as described elsewhere are available.
1207
1208 \subsection{Info Asset Details}%
1209 \label{sub:info_asset_details}
1210
1211 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.  
1212 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.
1213
1214 \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}.
1215
1216 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.
1217
1218 \begin{figure}[htpb]
1219     \centering
1220     \includegraphics[width=0.99\linewidth]{images/info_asset_details.png}
1221     \caption{The “Detail” box}
1222     \label{fig:info_asset_details}
1223 \end{figure}
1224
1225 \subsection{User Folders/Bins}%
1226 \label{sub:user_folders_bins}
1227
1228 Creating folders that are more specific to a particular project is helpful in better organizing your work.  
1229 This can be done by utilizing the files already loaded to the \textit{master} Media or Clips folders in the Resources window.  
1230 Below are steps illustrating an easy way to set up a folder.
1231
1232 %TODO Below part need to be rewriten
1233 \begin{enumerate}
1234     \item In the Resources window (figure~\ref{fig:folder_resources}), in the location of the Video/Audio effects and Media folders, bring up the \textit{Folder}$\dots$ popup by clicking the right mouse button.  
1235         Highlight, then click \textit{New Media or Clips}.
1236         \begin{figure}[htpb]
1237             \begin{minipage}{.55\linewidth}
1238                 \centering
1239                 \includegraphics[width=0.9\linewidth]{images/folder_resources.png}
1240                 \caption{Highlight, then click “New Media or Clips”.
1241                     “Modify folder” can be used to   change the name of a folder.
1242                     “Delete folder” in the popup can be used to delete a folder.
1243                 }
1244                 \label{fig:folder_resources}
1245             \end{minipage}
1246             \hfill
1247             \begin{minipage}{.35\linewidth}
1248                 \centering
1249                 \vspace{18ex}
1250
1251                 \includegraphics[width=0.9\linewidth]{images/folder_new.png}
1252                 \caption{Type in your folder name in the textbox.  Click OK.}
1253                 \label{fig:folder_new}
1254             \end{minipage}
1255         \end{figure}
1256     \item  In the \textit{New folder} popup as shown below (figure~\ref{fig:folder_new}), type in your folder name in the textbox.  Click OK.
1257         \begin{figure}[htpb]
1258             \centering
1259         \end{figure}
1260     \item  Select the \textit{master} Media folder to see which files are currently loaded, figure~\ref{fig:folder_master}.  
1261         Highlight the files there that you want to copy to your new folder (named Photos of Garden).  
1262         Drag the files to the left and when you see the Photos of Garden folder become highlighted, then drop there.  
1263         You can drag and drop any of the media from the \textit{master} Media at any time.  
1264         It flashes when the drop is successful.
1265 \end{enumerate}
1266
1267 \begin{wrapfigure}[12]{O}{0.53\linewidth} 
1268     \vspace{-3ex}
1269     \centering
1270     \includegraphics[width=0.9\linewidth]{images/folder_master.png}
1271     \caption{The “master” Media folder}
1272     \label{fig:folder_master}
1273 \end{wrapfigure}
1274
1275 Adding the Shift key before the actual drop, will allow for relative path filenames instead of full path.
1276 But you might want to include or eliminate some of the media that exists in one of the folders that you have set up already.  
1277 In this case you will want to click on the \textit{Modify folder} in the popup.  
1278 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.
1279
1280
1281 \begin{figure}[htpb]
1282     \centering
1283     %\includegraphics[width=0.8\linewidth]{name.ext}
1284     \begin{tikzpicture}[scale=1, transform shape]
1285         \node (img1) [yshift=0cm, xshift=0cm, rotate=0] {\includegraphics[width=0.7\linewidth]{images/folder_modify.png}};
1286         \node [yshift=-31mm, xshift=-1cm,anchor=east] at (img1.north west) (Arrow1) {\parbox{8em}{Here is the filter that was generated with the original drop }};
1287         \node [yshift=-85mm, xshift=0cm,anchor=east] at (img1.north west) (Arrow2) {\parbox{10em}{When you click on the 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.}};
1288         \draw [->, line width=1mm] (Arrow1) edge  ([yshift=-31mm] img1.north west);
1289         \end{tikzpicture}
1290     
1291     \caption{Modify target}
1292     \label{fig:modify-target}
1293 \end{figure}
1294
1295 To delete the entire set of files listed on the filter rule, highlight the rule line and hit the \textit{Del} button.  
1296 To add a new filter rule, click on the \textit{Add} button which will automatically add a default line after any current lines.  
1297 The default line will be a line that matches everything in the \textit{master} Media folder which is \textit{Or  Patterns  Matches   *}.  
1298 Click the right mouse button on the current field underneath the column header to see the choices available for each column.  
1299
1300 Modifications will not be in effect until you click on the green arrow OK button or click on the Apply button.  
1301 But once you hit Apply, clicking on the red X button will not undo your changes.  
1302 The filter/search rules are applied in the order listed in the Modify folder window.  
1303 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.
1304
1305 The figure~\ref{fig:modify_folder} below displays the available choices for each field.
1306
1307 \begin{figure}[htpb]
1308     \centering
1309     %\includegraphics[width=0.8\linewidth]{name.ext}
1310     \begin{tikzpicture}[scale=1, transform shape]
1311         \node (img1) [yshift=0cm, xshift=0cm, rotate=0] {\includegraphics[width=0.6\linewidth]{images/modify_folder1.png}};
1312         \node (img2) [yshift=-1cm, xshift=4cm, rotate=0] at (img1) {\includegraphics[width=0.6\linewidth]{images/modify_folder2.png}};
1313         \node (img3) [yshift=-1cm, xshift=3cm, rotate=0] at (img2){\includegraphics[width=0.3\linewidth]{images/modify_folder3.png}};
1314     \end{tikzpicture}
1315     \caption{The available choices for each field}
1316     \label{fig:modify_folder}
1317 \end{figure}
1318
1319 Information about the columns and rules for the search filters in the Modify folder window follows.
1320
1321 Column headers:
1322
1323 \begin{description}
1324 \item[ Enable]  this column is used to designate the state of that filter rule
1325     \begin{description}
1326         \item[ Off]             disable the filter
1327                 \item[And]              narrow your search; all of your search terms must be present
1328                 \item[Or]               broaden your search to include more values
1329                 \item[And Not]  exclude terms that do not contain the given value from your search results
1330                 \item[Or Not]   include terms that do not contain the given value from your search results
1331     \end{description}
1332 \item [Target] – this column designates which media asset attribute to look at
1333     \begin{description}
1334         \item[ Patterns]        each line contains a filename filter, matches the file path
1335                 \item[Filesize] number of bytes in a file
1336                 \item[Time]             date file was created
1337                 \item[Track Type]       track type of video, audio, or audio video (for both)
1338                 \item[Width]    Format width
1339                 \item[Height]   Format height
1340                 \item[Framerate]        Video framerate
1341                 \item[Samplerate]       Audio samplerate
1342                 \item[Channels] Number of audio channels
1343                 \item[Duration] Playback time in seconds -- it uses the largest of audio or video if contains both
1344     \end{description}
1345 \item[Op] – boolean operators used to narrow or broaden the relationship between your search terms
1346     \begin{description}
1347         \item[Around]   about this value; use \textit{+radius} for a search range: [target–radius$\dots$  target+radius]
1348         \item[Eq        ]       equal to
1349         \item[Ge]       greater than or equal to
1350         \item[Gt]       greater than
1351         \item[Ne]not equal
1352         \item[Le]       less than or equal
1353         \item[Lt] less than
1354         \item[Matches]  exactly matches for strings
1355     \end{description}
1356 \end{description}
1357
1358 \textbf{Value} --- the characteristic you are looking for with expressions that can be written with the following:
1359
1360 \begin{description}
1361 \item[Number] (decimal points are allowed and will be converted to a standard form):
1362     \begin{description}
1363         \item[inf] representing infinity
1364         \item[\#[TtGgMmKk]]  ---  where \# represents a number and the characters mean:
1365     \end{description}
1366
1367     \begin{tabular}{rcl}
1368         inf&=& infinity\\
1369         T&=&1099511627776\\
1370         t&=&1000000000000\\
1371         G&=&1073741824\\
1372         g&=&1000000000\\
1373         M&=&1048576\\
1374         m&=&1000000\\
1375         K&=&1024\\
1376         k&=&1000\\
1377     \end{tabular}
1378
1379 \item[Scalar:] 
1380
1381     \begin{tabular}{l}
1382         Number\\
1383         Number+Number\\
1384     \end{tabular}
1385 \item[Date time:]
1386     \begin{tabular}{rcl}
1387         date&=&year/month\\
1388         date&=&year/month/day\\
1389         time&=&hour:minute\\
1390         time&=&hour:minute:second\\
1391         date\_time&=&date time\\
1392     \end{tabular}
1393
1394   \item[Duration:]
1395       \begin{tabular}{rcl}
1396     day  &=&    \#day     | \#days\\
1397     week &=&    \#week    | \#weeks\\
1398     month&=&    \#month | \#months\\
1399     year &=&    \#year    | \#years\\
1400     delta&=&secs\\
1401     delta&=&mins:secs\\
1402     delta&=&hours:mins:secs\\
1403       \end{tabular}
1404
1405 \item[Around time:]
1406     date time+duration
1407
1408   \item[Around length:]
1409     duration+duration
1410
1411 \end{description}
1412
1413 Table showing the allowed usage:
1414
1415 %TODO create table for below code
1416 \begin{lstlisting}[numbers=none]
1417 target:    |  eq  ge  gt  ne  le  lt   matches  around
1418 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++
1419 patterns   | <---- strcmp ---------> + filter + nearest
1420 file_size  | <---- arithmetic -------+------> + radius
1421 mod_time   | <---- arithmetic -------+------> + radius
1422 track_type | <---- member test ------+--------+------>
1423 width      | <---- arithmetic -------+------> + radius
1424 height     | <---- arithmetic -------+------> + radius
1425 framerate  | <---- arithmetic -------+------> + radius
1426 samplerate | <---- arithmetic -------+------> + radius
1427 channels   | <---- arithmetic -------+------> + radius
1428 duration   | <---- arithmetic -------+------> + radius
1429 \end{lstlisting}
1430
1431 where in the above, the filter can be:
1432
1433 \begin{tabular}{rcl}
1434     filter&=&list\\
1435     filter&=&token\\
1436     list&=&[token]\\
1437     list&=&[token]list\\
1438     string&=&<chars>|<empty>\\
1439     token&=&string\\
1440     token&=&string*token\\
1441 \end{tabular}
1442
1443 Examples with some caveats first:
1444
1445 \begin{enumerate}
1446     \item   \textit{Or} generally includes or adds whereas \textit{And} generally excludes or subtracts.
1447     \item   The filters only work on media in the folder; if there is no media, then there is nothing to search.
1448     \item   The examples below are not meant to be executed as a list of filters in Modify folder, they are just single line examples to indicate what can work.
1449     \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.
1450 \end{enumerate}
1451
1452 \begin{table}[htpb]
1453     \centering
1454     \caption{Examples}
1455     \label{tab:label}
1456     \small
1457     \begin{tabular}{llllm{10em}} \toprule
1458         Enable& Target& Op&     Value&  meaning\\\midrule
1459 Or      &Patterns  &Matches   &*&        all files from the Media folder are included\\
1460 And Not&Filesize&Lt     &160000000& no files that are less than 160MB in size \\
1461 Or Not& Time    &Ge     &2018/07/30 06:13:00    & files not greater than or equal date\\
1462 And     &Duration&Eq    &01:00          & files included must have 60 secs. Duration\\
1463 Off     &Samplerate&Ne  &44000          & off for now, but may want to include later\\
1464 And     &Framerate&Around&24+1          & files included all have 24 to 25 framerate\\
1465 Or      &Patterns&Matches&[*.mp4]       & all files with the extension of mp4\\
1466 Or      &Time&  Around&2018/08/02 06:00:00 + 02:00:00  & files at 4AM to 8 AM\\\bottomrule
1467     \end{tabular}
1468 \end{table}
1469
1470
1471 \subsection{Vicons \& Aicons – aka Video Icons / Audio Icons}%
1472 \label{sub:vicons_aicons_aka_video_icons_audio_icons}
1473
1474 Vicons are video icons.  
1475 Aicons are audio icons.  
1476 By default the Resources window will play the first 5 seconds of video or audio waveform looped in the area occupied by the media icons (figure~\ref{fig:vicons1}). 
1477 This is enabled for the Media/Proxy folders in icon mode when the mouse pointer is inside the Resources window. 
1478
1479 \begin{figure}[htpb]
1480     \centering
1481     \includegraphics[width=0.99\linewidth]{images/vicons1.png}
1482     \caption{Note "Full Play" mode and Vicons and Aicons in Media folder}
1483     \label{fig:vicons1}
1484 \end{figure}
1485
1486 The waveform in the figure~\ref{fig:vicons2} is displayed in the Resources window in the color green/yellow for the 2 audio tracks. 
1487 There is a colored bar on the top of each a-icon where the color is based on the Color Spectrum -- the smaller the time duration, the redder the color; then as the time duration goes up, the color goes up so that you will go to green, then yellow, then blue, then really dark blue, then purple for the audio files 1 hour and over.  
1488 There are various other colors between these colors same as that seen in the color spectrum in the screenshot below.  
1489 Colors are utilized from the hue wheel in the counter-clockwise direction.  
1490 Note that the horizontal line in the middle of the a-icon is yellow/red representing the 2 audio tracks and is only red for mono.
1491
1492
1493
1494 \begin{figure}[htpb]
1495     \centering
1496     %\includegraphics[width=0.8\linewidth]{name.ext}
1497     \begin{tikzpicture}[scale=1, transform shape]
1498         \node (img1) [yshift=0cm, xshift=0cm, rotate=0] {\includegraphics[width=0.99\linewidth]{images/vicons2.png}};
1499         \node (img2) [yshift=0cm, xshift=2.8cm, rotate=0] at (img1.south west) {\includegraphics[width=0.3\linewidth]{images/hue_wheel.png}};
1500         \node [yshift=-5mm, xshift=1cm,anchor=west] at (img2.east) (Arrow1) {\parbox{18em}{Color hue wheel. For illustration only}};
1501         \draw [->, line width=1mm] (Arrow1) edge  ([yshift=-5mm] img2.east);
1502     \end{tikzpicture}
1503     \caption{Draw Vicons   |            Screenshot display various audio file lengths; red is shortest.}
1504     \label{fig:vicons2}
1505 \end{figure}
1506
1507 Note that if in \texttt{Settings $\rightarrow$ Preferences} under the Appearance tab, you have unchecked \textit{Use thumbnails in resource window} you will only have default icons and none of the above capabilities.
1508
1509
1510 \subsection{Resources Window Preview Mode}%
1511 \label{sub:resources_window_preview_mode}
1512
1513
1514 Preview mode can be used to pop up a window which draws the vicons/aicons thumbnails in a larger size.  
1515 Preview or \textit{draw vicons} mode is a helpful feature of Cinelerra that lets you see and/or hear the first 5 seconds of the video for identification purposes. 
1516 The Preview mode/playback toggle is to the right of the Visibility label as seen in the screenshot above. 
1517 Preview mode is available for the Media, Proxy, Media User Bins, and Clips but clips are only 1 image.
1518
1519 When \textit{Preview/draw vicons} is enabled/active, if you click on one of the video icons or an audio waveform icon, a view pops up that increases the size to 4 times the surface area larger. 
1520 This makes it easier to see or hear if it is the media you are looking for in case you have many similar media files. 
1521 To conserve memory, the video is stored 8\,bits per pixel which results in low image quality while the audio is 16\,bit. 
1522 The reason for playing 5 seconds of a video for a vicon is that until the first I-frame, the media frequently does not decode properly.  
1523 In other words, a lot of media does not begin at the \textit{beginning} point and will not be properly rendered until enough data has been read to assemble a picture.  
1524 You can increase the thumbnail size, clarity of pixels (memory size) and color mode but it takes a lot more memory.  
1525 Change these values in \texttt{Settings $\rightarrow$ Preferences}, Appearance tab, right hand side of the Layout section -- be aware that when you click OK, your session will re-initialize.  
1526 You can also temporarily increase the preview mini-window by use of the mouse wheel up or down.
1527
1528 There are 4 options for the preview mode.
1529
1530 \begin{enumerate}
1531     \item  \emph{Full Play} is the default mode.  
1532         This means all of the media will automatically play when the mouse is in the Resources window and you can use the left mouse button to click on specific media to see it pop up in a larger view.  
1533         Audio only files do not play the audio until the icon is clicked on and the waveform aicon pops up into the 4x larger mode. 
1534         \emph{Full Play} includes the \emph{Mouse Over} capabilities as described below as well as the Inter-View \emph{Src Target} functions.
1535
1536         \item  \emph{No Play} mode is especially useful on smaller computers and for users who find the constant loop play to be somewhat distracting.
1537
1538         \item  \emph{Mouse Over} mode is activated by a single click on one of the vicons/aicons and deactivated with another single click over any of the icons.  
1539     Once activated, whenever you just move the mouse over an icon, it automatically pops up the increased size preview.  
1540     The first time in your session that you enable this feature, it may take a few seconds to load all of the icon previews into memory so be patient and just wait.  
1541     \emph{Mouse Over} mode makes it quick and easy to preview without having to drag the media to the viewer.  
1542     You can still drag the media same as without preview enabled.  
1543
1544         \item  \emph{Src Target} mode gives easy access to the Inter-View source target available by using the middle mouse button on media.  
1545     There are 2 advantages to this mode -- there is no 5 second play loop taking up cpu time and the popup allows for the use of the letter “\texttt{f}” on that popup to have it go to fullscreen mode.  
1546     \emph{Src Target} mode in any scenario never plays sound as that is nonsensical usage.  
1547     After the initial click to pop media in this mode, you also have the \emph{Mouse over} feature.
1548 \end{enumerate}
1549
1550 For any of the options, but not \emph{No Play}, you can temporarily turn off that option by clicking on the button using the middle mouse button.  
1551 This helps to avoid having the thumbnail get in the way of dragging or other functions.  
1552 When you do, a line will be drawn through the current preview mode so that you are aware that it is in \emph{No Play} mode until click it again.
1553
1554 Note that if in \texttt{Settings $\rightarrow$ Preferences} under the Appearance tab, you have unchecked \textit{Use thumbnails in resource window} you will only have default icons and no active previews.
1555
1556 \begin{figure}[htpb]
1557     \begin{minipage}{.69\linewidth}
1558         \centering
1559         \includegraphics[width=0.99\linewidth]{images/preview_icon_mode.png}
1560         \caption{The location of the Preview/Draw Icons mode.}
1561         \label{fig:preview_icon_mode}
1562     \end{minipage}
1563     \hfill
1564     \begin{minipage}{.29\linewidth}
1565         \vspace{2ex}
1566         \centering
1567         \includegraphics[width=0.7\linewidth]{images/line_through_mode.png}
1568         \caption{Note the line through the mode.}
1569         \label{fig:line_through_mode}
1570     \end{minipage}
1571 \end{figure}
1572
1573
1574
1575 \subsection{Moving clips/media from/to Resources window}%
1576 \label{sub:moving_clips_media_from_to_resources_window}
1577
1578 If you have several media files loaded into the Resources window of one instance of Cinelerra and want to load some of the same ones into another instance or just want a listing to save in a file for later use, you can do this with these set of steps:
1579
1580 Copy or paste a list of files in the Media Resources window:  
1581
1582
1583 \begin{enumerate}
1584     \item  create a highlighted selection of the desired media files in the media Resources window
1585     \item    right click on an unused portion of that window to bring up the popup menu
1586     \item     select the \textit{Copy file list} item and a file list box will appear that contains the full path filenames
1587     \item     wipe the textbox using your standard copy/paste method to put the list of files in the copy buffer
1588     \item     in another Cinelerra instance, choose the \textit{Paste file list} of the media Resources window
1589     \item     paste the list of files, again using your standard paste method, into the new file list box; press OK
1590     \item    the status bar of the main window will be updated as the file list is loaded to the media folder (the purpose of displaying the status is simply to show that the load is progressing normally).
1591 \end{enumerate}
1592
1593 Obviously this \textit{Paste file list} feature means you can create a list of files outside of Cinelerra using an editor, wipe the names, and then use \textit{Paste file list} to load them into the media Resources window.  
1594
1595 It is important to note that in the steps above, the Operating System cut and paste capabilities are in use for steps 4 and 6 as opposed to Cinelerra’s c/v shortcuts.  
1596 Since the procedure varies among the distros, you will have to adapt to your specific one.  For example, a usage for ubuntu consists of:
1597 \begin{enumerate}
1598     \setcounter{enumi}{3}
1599     \item   Ctrl-c to copy the list of files; open gedit; Ctrl-v to paste the list of files into gedit
1600     \item   Ctrl-c or the standard way using the right click to copy this list from gedit
1601     \item Ctrl-v paste the list of files into the new file list box, and press OK
1602 \end{enumerate}
1603
1604 \begin{figure}[htpb]
1605     \centering
1606     \begin{minipage}{.49\linewidth}
1607     \centering
1608         \includegraphics[width=0.99\linewidth]{images/copy_files1.png}
1609     \end{minipage}
1610     \hfill
1611     \begin{minipage}{.49\linewidth}
1612     \centering
1613         \includegraphics[width=0.99\linewidth]{images/copy_files2.png}
1614     \end{minipage}
1615     \caption{Example of copy file list}
1616     \label{fig:copy_files1}
1617 \end{figure}
1618
1619 In the Figure~\ref{fig:copy_files1}, one instance of Cinelerra has 6 items in the Media area highlighted that were copied to the file list.  
1620 Note how it includes the full pathname.
1621
1622 In this screenshot on another instance of Cinelerra, there are only 2 items in the media but the \textit{Paste file list} box is ready to have the items inserted via the standard text box paste method.  When that is done, the additional 6 media files will be available on this other instance too.
1623
1624
1625 Another possible usage of this capability:
1626
1627 \begin{enumerate}
1628     \item  Right Click on the Clips Resources window and use the \textit{Paste Clip} option to paste the Copy selection as a clip.  
1629     \item  Similarly, by highlighting a clip in the Resources window and selecting its copy popup menu item using the right mouse button, that copy buffer can now be loaded onto the timeline.
1630 \end{enumerate}
1631
1632
1633 \subsection{Snapshot / Grabshot}%
1634 \label{sub:snapshot_grabshot}
1635
1636 \begin{figure}[htpb]
1637     \centering
1638     \begin{minipage}{.49\linewidth}
1639     \centering
1640     \includegraphics[width=0.8\linewidth]{images/snapshot.png}
1641     \caption{Snapshot menu and choices}
1642     \label{fig:snapshot}
1643     \end{minipage}
1644     \begin{minipage}{.49\linewidth}
1645     \centering
1646     \begin{tikzpicture}[scale=1, transform shape]
1647         \node (img1) [yshift=0cm, xshift=0cm, rotate=0] {\includegraphics[width=0.65\linewidth]{images/grabshot.png}};
1648         \node (img2) [yshift=2cm, xshift=-1cm, rotate=0] {\includegraphics[width=0.07\linewidth]{images/reticle.png}};
1649     \end{tikzpicture}
1650     \caption{Grabshot reticle \& orange box}
1651     \label{fig:grabshot_recticle}
1652     \end{minipage}
1653 \end{figure}
1654
1655 To take a snapshot, perform the following steps:
1656
1657 \begin{enumerate}
1658     \item set your timeline insert marker where you want the snapshot -- this frame shows in the compositor
1659     \item  right click in an empty spot in the media folder and the popup shows snapshot as the $5^{th}$ item down
1660     \item  highlight that and the submenu comes up allowing you to choose png, jpg, ppm or tiff
1661 \end{enumerate}
1662
1663 The snapshot shows up in the Media folder.  
1664 It is saved by default in \texttt{/tmp} as
1665
1666 \texttt{snap\_date-time.ext} BUT you can change the default directory path in \texttt{Settings $\rightarrow$ Preferences $\rightarrow$ Interface tab} in the right hand side of the Editing section.
1667
1668 Grabshot is the $6^{th}$ menu item.  
1669 A red circle reticle can be moved to the area to grab; use left mouse drag to surround an area; and right click to grab.
1670
1671
1672
1673
1674 \section{Other Options and Other Windows}%
1675 \label{sec:other_options_and_other_windows}
1676
1677 \subsection{Transport Controls}%
1678 \label{sub:transport_controls}
1679
1680 Transport controls are useful for navigation and for playing media.  
1681 Each of the Viewer, Compositor, and Program windows has its own transport panel.  
1682 The controls generally all contain a yellow colored tooltip when you mouse over the control, providing a hint of their function and shortcuts for usage.
1683
1684 The transport panel is controlled by the keyboard as well as the graphical interface. 
1685 For each of the operations it performs, the starting position is the position of the insertion point in the Program window and the slider in the Compositor and Viewer windows. 
1686 The ending position is either the end or start of the timeline or the end or start of the selected region if there is one.
1687
1688 The orientation of the end or start depends on the direction of playback. 
1689 If it is forward the end position is the end of the selected region. 
1690 If it is backward the end position is the start of the selected region.  
1691 The insertion point moves to track playback. 
1692 When playback stops, the insertion point stays where playback stopped. 
1693 Thus, by playing back you change the position of the insertion point. 
1694 The keyboard interface of either the numeric pad or alternative keys has more speeds with the addition of \emph{Forward Slow}(2) and \emph{Reverse Slow} (5).  
1695 Hitting any key on the keyboard twice pauses it. 
1696 The shortcuts section of this manual as well as a Shell Command available from the Cinelerra main window has a listing of each of the keys.
1697
1698 When using frame advance functions the behavior may seem odd. 
1699 If you frame advance forward and then frame advance backward, the displayed frame does not change. 
1700 This is because the playback position is not the frame but the time between two frames. 
1701 The rendered frame is the area that the playback position crosses. 
1702 When you increment the time between two frames by one and decrement it by one, you cross the same frame both times and so the same frame is displayed.  
1703 There is an option in \texttt{Settings $\rightarrow$ Preferences, Appearance tab} to \textit{Always show next frame} that may help make this clearer for some users.
1704
1705 The transport behavior changes if you hold down Ctrl when issuing any of the transport commands. This causes the starting point to be the In point if playing forward and the Out point if playing backward. If playing forward, the Out point becomes the ending point and if playing backward, the In point becomes the ending point. If no In/Out points are specified, the behavior falls back to using the insertion point and track boundaries as the starting and ending points.
1706
1707 The transport behavior also changes if you hold down the Shift key along with KeyPad 1--6.  
1708 If normally audio is included in the play, it will be removed and if normally audio is not included in the play, it will be added.
1709
1710
1711 \subsection{Zoombar}%
1712 \label{sub:zoombar}
1713
1714 The compositor has zoom capability. 
1715 The pull-down menu on the bottom of the compositor window has a number of zoom options. 
1716 When set to Auto the video is zoomed to match the compositor window size as closely as possible. 
1717 When set to any other percentage, the video is zoomed a power of 2 and scrollbars can be used to scroll around the output. 
1718 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.
1719
1720 The zoom toggle also causes the Compositor window to enter zoom mode. 
1721 In zoom mode, clicking in the video output zooms in while a Ctrl-click in the video output zooms out. 
1722 If you have a wheel mouse, rotating the wheel zooms in or out too. 
1723 Zooming in or out with the zoom tool does not change the rendered output. 
1724 It is merely for scrutinizing video or fitting it in the desktop. Playing video on the compositor when zoomed to any size other that 100\%, the original size, requires Cinelerra to do extra processing steps. 
1725 This could affect performance on slower systems
1726
1727 \subsection{Show Overlays}%
1728 \label{sub:show_overlays}
1729
1730 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.  
1731 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.  
1732 The \textit{Color Coded Keyframe Curves} have distinct colors associated with each type for ease of identification.  
1733 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.  
1734 The color ball changes made will be retained across sessions.
1735
1736 There is a line separating the first 4 items, which are just non-automation type settable values as opposed to \textit{auto} keyframe types.  
1737 The color is not changeable for the 3 items of Mode, Pan, and Mask which simply display their symbol icon.
1738
1739 Screenshot below displays the Show overlays popup with all of its options and color coded types such as yellow for Speed and blue for Camera Z.  
1740 Upon clicking on the associated \textit{color ball} to the right of any keyframe type, for example \textit{Fade} in this screenshot, the color wheel palette window pops up so that you can manipulate the color as desired.
1741
1742 \begin{figure}[htpb]
1743     \centering
1744     \includegraphics[width=0.99\linewidth]{images/overlays_window.png}
1745     \caption{Show Overlays window on the left with the Color ball window to the right to set color}
1746     \label{fig:overlays_window}
1747 \end{figure}
1748
1749 Screenshot below shows several color coded lines for different keyframes along with the Fade slider for manipulation.  
1750 The slider is in the same color as the color coded keyframe type line which is the same color as in the \textit{Show overlays} window.
1751
1752 \begin{figure}[htpb]
1753     \centering
1754     \includegraphics[width=0.8\linewidth]{images/overlays1.png}
1755     \caption{Lines are colored here on the timeline as designated in Show Overlays}
1756     \label{fig:overlays1}
1757 \end{figure}
1758
1759 Overlays Window Nuances:
1760
1761 The Overlays window is an alternative to the main track canvas View pulldown, and thus the order is mostly maintained to match each other.  
1762 To make it easier to get a quick temporary look at a specific option, there is a shortcut of Shift-LMB (left mouse button) that can be used as opposed to having to uncheck everything that is currently checked and then having to recheck them on when done.  
1763 Here is a list of how they work.  Keep in mind that if the Expander on the patchbay is enabled, you still see the track.
1764
1765 \begin{itemize}
1766     \item  Shift+LMB (left mouse button) in the Overlays Window on a checkbox will turn off all other
1767         checkboxes except for the one you are on.  Then this named box will have outline for a  \textit{hot} spot.
1768     \item  Shift+LMB on this \textit{hot} spot will return to \textit{cool} of the previous settings with all of the previous
1769         checkboxes checked again.
1770     \item  Shift+LMB on a non-\textit{hot} spot will simply check or uncheck a box and there is no previous state.
1771     \item This all works in conjunction with the View pulldown menu which, of course, has no hot spots.
1772     \item  Caveat \#1 - Shift+LMB on the top 4 choices of Assets, Titles, Transitions, Plugin Keyframes will turn
1773         off all of the checkboxes below because it makes sense to do so.
1774     \item  Caveat \#2 - Shift+LMB on the Autos will not turn off Assets, Titles, Transitions, or Plugin Keyframes
1775         because you need to be able to see what is going on.
1776         \item Caveat \#3 - XYZ toggle on/off of Camera and Projector are not affected.
1777 \end{itemize}
1778
1779 \begin{figure}[htpb]
1780     \begin{minipage}{.29\linewidth}
1781         \centering
1782         \includegraphics[width=0.99\linewidth]{images/overlays_list1.png}
1783         \caption{Original Settings --- cool spot}
1784         \label{fig:overlays_list1}
1785     \end{minipage}
1786     \hfill
1787     \begin{minipage}{.29\linewidth}
1788         \centering
1789         \includegraphics[width=0.99\linewidth]{images/overlays_list2.png}
1790         \caption{Note Titles box hot spot  }
1791         \label{fig:overlays_list2}
1792     \end{minipage}
1793     \hfill
1794     \begin{minipage}{.29\linewidth}
1795         \centering
1796         \includegraphics[width=0.99\linewidth]{images/overlays_list3.png}
1797         \caption{Cam/Proj XYZ toggle to fine tune}
1798         \label{fig:overlays_list3}
1799     \end{minipage}
1800 \end{figure}
1801
1802
1803 \subsection{Sound Level Meters Window}%
1804 \label{sub:sound_level_meters_window}
1805
1806 An additional window, the levels window, can be brought up from the Window pulldown.  
1807 The levels window displays the output audio levels after all mixing is done.  
1808 The visible range of the sound level meters is configurable in \texttt{Settings $\rightarrow$ Preferences, Interface tab} under the Operations section.
1809
1810 \begin{wrapfigure}[16]{O}{0.3\linewidth} 
1811     \centering
1812     %\vspace{-4ex}
1813     \includegraphics[width=0.5\linewidth]{images/volume_meter.png}
1814     \caption{Sound Level Meters Window}
1815     \label{fig:volume_meter}
1816 \end{wrapfigure}
1817
1818 Sound level meters can be toggled in the viewer and compositor windows with the show meters button.  
1819 They also appear in the patchbay when the track is expanded and in the recording monitor when audio is being recorded. 
1820
1821 The sound levels in the levels window, compositor, and viewer correspond to the final output levels before they are clipped to the sound card range.  
1822 In the record monitor they are the input values from the sound card.  
1823 In the patchbay they are the sound levels for each track after all effects are processed and before down-mixing for the output.  
1824 Most of the time, audio levels have numerical markings in dB but in the patchbay there is not enough room.
1825
1826
1827
1828 The sound level is color coded as an extra means of determining the sound level.  
1829 Even without numerical markings, the sound level color can distinguish between several ranges and overload.  
1830 Look at the color codings in a meter with numerical markings to see what colors correspond to what sound level.  
1831 Then for meters in the patchbay in expanded audio tracks, use the color codings to see if it is overloading.
1832
1833 Be aware that sound levels in Cinelerra can go above 0 dB.  
1834 This allows for not only seeing if a track is overloading but how much information is being lost by the overloading.  
1835 Overloading by less than 3 dB is usually acceptable.  
1836 While overloading is treated as positive numbers in Cinelerra, it is clipped to 0 when sent to a sound card or file.
1837
1838
1839
1840
1841
1842
1843