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