1 \chapter{The 4+ Windows}%
2 \label{cha:the_4_windows}
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}
12 \section{Program Window}%
13 \label{sec:program_window}
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}).
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 was 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}.
28 \subsection{Video and Audio Tracks and Navigation}%
29 \label{sub:video_and_audio_tracks_and_navigation}
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.
36 \includegraphics[width=0.8\linewidth]{images/patchbay.png}
37 \caption{Patchbay | Timeline with pulldowns, navigation icons, Video/Audio tracks | bottom Zoom Panel}
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.
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.
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.
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.
62 \subsection{Zoom Panel}%
63 \label{sub:zoom_panel}
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.
71 \begin{tabular}{ l l }
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 \\
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.
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.
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.
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.
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.
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.
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).
121 \subsection{Track Popup Menu}%
122 \label{sub:track_popup_menu}
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:
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.
148 \subsection{Insertion Point}%
149 \label{sub:insertion_point}
151 The insertion point (figure~\ref{fig:insertion-points}) is the vertical hairline mark that spans the timeline in the program window - it can be a solid line but most of the time it will be flashing.
152 Like the cursor on a word processor, the insertion point marks the place on the timeline where the next
153 operation will begin. It is the starting point of all play operations and is the point where a paste operation will occur.
154 In some cases, when rendering it defines the beginning of the region of the timeline to be rendered.
156 To move the insertion point, you move the mouse inside the timebar area and click with the left mouse button.
157 You can use any place on the timebar to reposition the insertion point as long as that spot is not blocked
158 by In/Out point or a label.
159 In cut and paste editing mode, you can also change the position of the insertion point with a simple
160 left mouse click in the timeline itself.
161 When moving the insertion point, the position is either aligned to frames or aligned to samples.
162 For best results, "Align cursor on frames" when editing a video track and "Align to samples" when editing audio.
163 Use the pulldown \texttt{Settings$\rightarrow$Align cursor on frames} to change the alignment by
164 checking the box on for video and off for audio.
168 %\includegraphics[width=0.8\linewidth]{name.ext}
169 \begin{tikzpicture}[scale=1, transform shape]
170 \node (img1) [yshift=0cm, xshift=0cm, rotate=0] {\includegraphics[width=0.6\linewidth]{images/insertion-point.png}};
171 \node [yshift=-13mm, xshift=-1cm,anchor=east] at (img1.north west) (Pulldowns) {Pulldowns};
172 \node [yshift=-20mm, xshift=-1cm,anchor=east] at (img1.north west) (Transport) {Transport \& Buttons Bar};
173 \node [yshift=-27mm, xshift=-1cm,anchor=east] at (img1.north west) (Timebar) {Timebar};
174 \node [yshift=-33mm, xshift=-1cm,anchor=east] at (img1.north west) (Title) {Media Title };
175 \node [yshift=-43mm, xshift=-1cm,anchor=east] at (img1.north west) (Video) {Video Track};
176 \node [yshift=-63mm, xshift=-1cm,anchor=east] at (img1.north west) (Audio) {Audio Track};
177 \draw [->, line width=1mm] (Pulldowns) edge ([yshift=-13mm] img1.north west);
178 \draw [->, line width=1mm] (Transport) edge ([yshift=-20mm] img1.north west);
179 \draw [->, line width=1mm] (Timebar) edge ([yshift=-27mm] img1.north west);
180 \draw [->, line width=1mm] (Title) edge ([yshift=-33mm] img1.north west);
181 \draw [->, line width=1mm] (Video) edge ([yshift=-43mm] img1.north west);
182 \draw [->, line width=1mm] (Audio) edge ([yshift=-63mm] img1.north west);
185 \caption{Insertion point is at 0:00:25:10 in Hr:Mn:Sec:Frames}
186 \label{fig:insertion-points}
190 \subsection{Editing Modes}%
191 \label{sub:editing_modes}
193 There are 2 different editing modes for operations which affect how the insertion point and editing
194 on the timeline operate.
195 There is: \emph{drag and drop mode} and \emph{cut and paste mode}.
196 The editing mode is determined by selecting the \texttt{arrow}, or immediately to the right of the arrow,
197 the \texttt{I-beam} in the Transport and Buttons bar. In figure~\ref{fig:insertion-points} you can see
198 the green colored highlight on the arrow icon indicating that you are currently in
199 \emph{drag and drop mode}.
201 With the arrow highlighted for \emph{drag and drop mode}, a double click with the left mouse button in the timeline selects the edit the mouse pointer is over.
202 Then dragging in the timeline repositions that edit and this can be used for moving effects,
203 changing the order of playlists, or moving video pieces around.
204 There are numerous methods to cut and paste in \emph{drag and drop mode} by setting In/Out points to define
205 a selected region or using the Copy/Paste Behavior as outlined in \ref{sub:copy_paste_behavior}.
206 In this mode, clicking the LMB in the timeline does not reposition the \textit{Insertion Point}.
208 When the I-beam is highlighted, you are in \emph{cut and paste mode}.
209 In cut and paste mode, clicking the LMB in the timeline does reposition the \textit{Insertion Point}.
210 Double clicking in the timeline selects the entire edit the cursor is over, i.e. that column.
211 Dragging in the timeline with the LMB pressed down, highlights a selected region and this is the region that is affected by cut
212 and paste operations. It is also the playback range used for the subsequent playback operation.
213 Holding down the Shift key while clicking in the timeline extends the highlighted region.
217 \includegraphics[width=0.4\linewidth]{images/i-beam.png}
218 \caption{I-beam + in/out + labels}
222 \subsection{In/Out Points}%
223 \label{sub:in_out_points}
225 The In/Out points, displayed on the timebar by [ and ] brackets, can be set in either of the editing modes to define the selection.
226 In the timebar, a colored bar will show between these 2 brackets to better outline the area selected.
227 In \emph{drag and drop mode}, they are an easy way to define a selected region.
229 It is important to remember that in \emph{cut and paste mode} and \emph{drag and drop mode}, a highlighted area
230 overrides the In/Out points. That is, if a highlighted area and In/Out points are both set, the highlighted area is changed by editing operations and the In/Out points are ignored.
231 But if no region is highlighted, the In/Out points are used.
232 To avoid confusion, use either highlighting or In/Out points but not both at the same time.
234 To set In/Out points, in the timebar move to the position where you want the In point and click the In
235 point icon or one of the [ or < keys.
236 Then move the insertion point to a position after the In point and click the ] or > or the Out point icon.
237 You can use these same icons or keyboard characters to toggle In/Out points on or off.
239 If you set the insertion point in another place when In/Out points are already set, that existing point will be
240 repositioned when you click the In/Out icon or keyboard equivalent.
241 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.
243 When you select either the In or Out point on the timebar, the insertion point will move to that location.Note that when the insertion point is at the exact position of an In or Out point, the bracket will change
244 color making it easy to see that you are exactly at that spot.
246 If only the In point is set, when you click the In point icon the In point will be deleted.
247 If only the Out point is set, when you click the Out point icon the Out point will be deleted.
248 Holding the Shift key while clicking on an In/Out point, the area between the insertion point and that
249 In/Out point will be highlighted or extended to that In/Out point if already highlighted.
251 An easy way to turn off the In/Out points if both are set, is to double click on the [ icon.
252 If you have already set the In and Out points, and then move the insertion point anywhere to the left of
253 the Out point, a LMB click on the [ icon will move the In point to the location of the insertion point. In the same
254 manner if you move the insertion point anywhere to the right of the In point, a LMB click on the ] icon
255 will move the Out point to that new position. However, if you move the insertion point for either the
256 In or Out point beyond what makes sense to designate In/Out points, the bracket you clicked on will be
257 moved to the insertion point and the other bracket will be eliminated. That is obviously because the
258 In point has to come before the Out point on the timeline.
260 Some of the useful operations concerning the In/Out pointers are listed next.
263 \item[Ctrl-KeyPad\#] if In/Out set, \texttt{KP 2,3,5,6 + Enter}, play between In/Out points
264 \item[Shift-Ctrl] loops play between In/Out points
265 \item[Click In/Out] while holding the LMB down, drags In/Out pointer where you drag to
266 \item[Shift-Ctrl] with a transport button (e.g. Fast Forward), loops play between In/Out points
267 \item[Ctrl-t] clears both In/Out points
273 Labels are used in order to set exact locations on the timeline that you want to be able to easily get to.
274 To create a label, position the insertion point at a location and click on the label icon in the Transport
275 and Buttons bar. The new label is displayed on the timebar as a down arrow at that location as shown in
276 figure~\ref{fig:i-beam}. Whenever the insertion point is at the same position as a label, it changes
277 color to emphasize that it is exactly at that spot.
278 Labels make it so you can jump back and forth to exact marked locations on the timeline.
279 Use the lower case letter “\texttt{L}” as a shortcut for the label button.
281 You can use labels to reposition the insertion point when that label is selected. They are also
282 especially useful for moving along the timeline to the \textit{Next label} or \textit{Previous label}
283 with the buttons on the Transport and Buttons bar to the right of the Labels button.
284 When moving along the timeline with the Next or Previous label buttons, if a label is out
285 out of view the timeline will automatically be repositioned so that the label is visible.
286 If you perform a \textit{Next label} operation and there are no more, the insertion point
287 will go to the End position. Conversely if you perform a \textit{Previous label} operation
288 and there are no more labels, the insertion point will go to the Home position.
289 Keyboard shortcuts for label traversal are:
292 \item[Ctrl-left] moves the insertion point to the previous label.
293 \item[Ctrl-right] moves the insertion point to the next label.
296 There is a Label folder in the Resources window which has a list of every label and its exact location
297 where the label is. The location is based on the timestamp, frame number, or sample number depending on the selected Time Format of your timebar.
298 You can edit, delete, or goto a label by clicking the RMB on that label in the Resources window which
299 brings up a popup menu with those options. It can be quite helpful to \textit{edit} the label
300 and add a text string to help identify what the label represents.
301 In addition, RMB clicking the label symbol on the timebar brings up a textbox displaying the current
302 text string and allowing you to change it. If a Label has been given a name, simply mousing over
303 the label symbol on the timebar will display that string.
305 With labels you can also select regions:
308 \item[Shift-Ctrl-left] highlights the area between the insertion point and the previous label.
309 \item[Shift-Ctrl-right] highlights the area between the insertion point and the next label.
310 \item[Double-clicking] on the timebar between two labels, highlights the area between the labels.
311 \item[Shift-clicking] on a label, highlights the area between that label and the insertion point.
312 If an area is already highlighted, it extends the highlighted area up to that label.
315 If you LMB click the label button when an area is highlighted, labels are created at each end of the
317 When a label is selected, if you click on the label icon, the label will be deleted.
318 To delete multiple labels, highlight that area, then use the \texttt{Edit $\rightarrow$ Clear labels}
319 function to delete them all. The same precedence rules apply to this operation as mentioned earlier. That
320 is, if both In/Out points are set and there is a highlighted area also set, the highlighted area's
321 labels will be cleared and not those between the In/Out points.
323 If you enable \emph{Edit labels} in the Settings pulldown menu or disable the \emph{Lock labels from moving}
324 button on the Transport and Buttons bar, labels will be cut, copied or pasted along with the selected
325 area of the first armed track.
326 In the same manner, if a selected area of media is spliced from the viewer to the timeline in a position
327 before labels, the labels will be moved to the right on the timebar so that the label maintains its
328 relative position to its edit.
329 To prevent labels from moving on the timebar, enable the \emph{Lock labels from moving} icon or
330 disable the \emph{Edit labels} option under the Settings pulldown.
332 \subsection{Color Title Bars and Assets}%
333 \label{sub:color_title_bars_and_assets}
335 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.
336 Use of this feature requires additional memory and cpu on every timeline redraw, therefore it is recommended that smaller computers leave it turned off.
338 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.
339 To enable auto-color go to \texttt{Settings $\rightarrow$ Preferences, Appearance tab} and check on \texttt{Autocolor assets}. You will see this in the Flags section
340 as shown in Figure~\ref{fig:settings}. It is disabled by default.
341 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.
343 To change a specific clip to your own chosen color, middle mouse button (MMB) over that clip and an Edits popup will be displayed.
344 Choose the option \textit{Bar Color} to bring up the color picker and choose a color.
345 You can also change the alpha value in the color picker and this alpha takes precedence over the current alpha slider bar value unless the color picker's alpha value is set to 1.0.
346 The color will only change after you click on the checkmark.
347 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.
348 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.
350 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.
351 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.
352 Self-color does honor armed/disarmed tracks.
355 There is an \emph{alpha fader slider bar} on the bottom of the main window on the right hand side of the Zoom Panel.
356 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 at 1.0.
357 This slider bar affects all colored areas of the Autocolor assets and the self-colored ones.
358 In the case when a specifically changed edit alpha value is set in the color picker
359 to any value except 1, the slider bar will not affect that.
360 Once you use the slider bar, it is activated so gets first shot at any keystrokes in the main window.
361 You deactivate this by simply clicking in a different part of the main window.
363 As long as we are on the subject of color, just a note that you can also change the \textit{Highlighting Inversion color} in \texttt{Settings $\rightarrow$ Preferences, Appearance tab}. You can see this option in Figure~\ref{fig:settings} in the Color section.
364 That setting defaults to white ($ffffff$) but sometimes this is a little bright so you can put any hex value in that suits you.
366 This image (figure~\ref{fig:autocolor_assets_alpha}a) shows an example of the Autocolor assets with alpha set to 0.0 so that you see only the color and no image.
367 In this image (figure~\ref{fig:autocolor_assets_alpha}b), the alpha is set to show the image
368 and waveforms with transluent colors. The pink media file has been self-colored rather than the autocolor to make it easy to see.
372 \begin{minipage}[h]{0.55\linewidth}
373 \center{\includegraphics[width=0.99\linewidth]{images/autocolor-assets_alpha0.png}} \\ a)
375 \begin{minipage}[h]{0.4\linewidth}
376 \center{\includegraphics[width=0.99\linewidth]{images/autocolor-assets_alpha1.png}} \\ b)
378 \caption{An example of the Autocolor assets}
379 \label{fig:autocolor_assets_alpha}
383 \subsection{More about Pulldowns}%
384 \label{sub:more_about_pulldowns}
386 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.
388 %TODO Figure 3 shows an example of the pulldowns as displayed in the main window.Appearance
392 \item[File] options for loading, saving, and rendering as described in other sections (\ref{cha:load_save_and_the_EDL}).
393 \item[Edit] edit functions; most of which have shortcuts that you will quickly learn (\ref{cha:editing}).
394 \item[Keyframes] keyframe options which are described in the Keyframe section (\ref{cha:keyframes}).
395 \item[Audio] audio functions such as \textit{Add track}, \textit{Attach transition/effect}.
396 \item[Video] video functions such as \textit{Add track, Default/Attach transition, Render effect}.
397 \item[Tracks] move or delete tracks are the most often used.
398 \item[Settings] much of this is described elsewhere with the most frequently used to include
399 Preferences (\ref{cha:configuration_settings_preferences}), Format (\ref{cha:project_and_media_attributes}),
400 Proxy and Transcode (\ref{sec:proxy_settings}), as well as the others.
401 \item[View] for display or modifying asset parameters and values to include Fade, Speed, and Cameras.
402 \item[Window] window manipulation functions.
406 \subsection{Window Layouts}%
407 \label{sub:window_layouts}
409 If you like to use different window layouts than the default for certain scenarios, you can setup, save, and load 4 variations.
410 First, position your Cinelerra windows where you want them to be and then use the Window pulldown and choose \emph{Save layout}. Note the words \emph{Save layout} highlighted in Figure~\ref{fig:window_layouts}a with 4 names shown to the right and below of that highlight.
411 To use the default name of \textit{Layout \#}, when the popup comes up, just click the green checkmark OK on the Layout popup menu.
412 If you would like a specific name for your layout so you can remember what its best use case is,
413 keyin 1-8 english characters that are meaningful to you (english characters mean you can not use the German umlaut or the French accent).
414 Legal characters are a-z, A-Z, 0-9, \_ (the underscore character) and a limit of 8 total.
415 If you keyin more than 8, only the last 8 characters will be used.
416 To rename a currently existing layout, use the \emph{Save layout} option again on the one to rename, and keyin a different name into the text box or leave blank for the default name (figure~\ref{fig:window_layouts}b).
420 \begin{minipage}{.49\linewidth}
421 \center{\includegraphics[width=1\linewidth]{images/window_layout1.png}}\\ a)
422 %TODO High res image replace
424 \begin{minipage}{.49\linewidth}
426 \center{\includegraphics[width=1\linewidth]{images/window_layout2.png}}\\ b)
429 \caption{Window Layouts}
430 \label{fig:window_layouts}
433 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}.
435 To use the desired layout, keyin the shortcut or use the Window pulldown and choose \emph{Load layout} and then make your choice. It is very beneficial to learn the shortcuts for your
436 layouts because they can be executed from any of the 4 windows instead of just the main
439 \subsection{Just Playing!}%
440 \label{sub:just_playing_}
441 What if you are just using Cinelerra to play media and listen to tunes?
442 After loading your media, just hit the space bar to start playing and then again to stop playing.
443 Other than that, use the transport buttons on the top bar of the Program window.
444 Other ways to \textit{play around} are described next.
446 \subsubsection*{Repeat Play / Looping Method}%
447 \label{ssub:repeat_play_looping_method}
449 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.
451 \textit{Method 1:} Shift-L on the Timeline, repeats the selection per the algorithm outlined next.
453 When setup, long green lines are displayed across the entire set of tracks which shows the start and end of the loop.
455 \item Highlighted selection repeats loop and takes precedence over all other possibilities.
456 If the cursor is before the highlighted area, it will play up to the area and then repeat the highlighted section.
457 If the cursor is after the highlighted section, play will start at the beginning until you get to the
458 highlighted section and then repeat.
459 \item When both In and Out pointers are set, it repeats the section between [ and ].
460 \item If only one of the In or Out pointers is set, it loops the whole media.
463 \textit{Method 2:} Ctrl+Shift+transport button on the Timeline, Viewer, and Compositor
466 \item Repeats entire media if no In or Out pointer set.
467 \item In and Out pointer set, repeats area between pointers.
468 \item Only In pointer set, repeats from In to end of media.
471 \subsubsection*{Last Play Position Memory}%
472 \label{ssub:last_play_position_memory}
475 When you play media, the start/end playback positions are saved as if they had been made into temporary labels.
476 They appear on the timeline as purple/yellow hairline markers representing the last start/end labels for the last playback.
477 They can be addressed as if they are label markers using:
480 \item[Ctrl$\leftarrow$] tab to the label before the cursor, that is \textit{play start}
481 \item[Ctrl$\rightarrow$] tab to the label after the cursor, that is \textit{play stop}
485 You can use these markers for re-selection.
486 Additionally, the selection region can be expanded by \textit{pushing} the markers using single frame playback.
487 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.
489 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.
490 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.
491 Now you can clip/play/expand or edit the previous playback selection.
494 \item[Ctrl SHIFT$\rightarrow$] tab cursor to label right of cursor position and expand selection
495 \item[Ctrl SHIFT$\leftarrow$] tab cursor to label left of cursor position and expand selection
499 \subsubsection*{Playback Speed Automation Support}%
500 \label{ssub:playback_speed_automation_support}
503 The speed automation causes the playback sampling rate to increase or decrease to a period controlled by the speed automation curve.
504 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). For more information on changing
505 the speed, read the section on Speed Automation \ref{sec:speed_fade_automation_gang}.
507 \subsubsection*{Alternative to using Numeric Keypad for Playing}%
508 \label{ssub:alternative_to_using_numeric_keypad_for_playing}
511 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.
514 Alt + m&=&stop playback\\
516 Alt + j&=&forward single frame\\
518 Alt + k&=&forward slow playback\\
520 Alt + l&=&forward normal playback\\
522 Alt + ;&=&forward fast playback\\
524 Alt + u&=&reverse single frame\\
526 Alt + i&=&reverse slow playback\\
528 Alt + o&=&reverse normal playback\\
530 Alt + p&=&reverse fast playback\\
532 \begin{minipage}{.45\linewidth}
533 + Shift key, results in the reverse of whether audio is included or not.
536 + Ctrl, results in the transport function operating only between the in/out pointers.
539 \section{Compositor Window}%
540 \label{sec:compositor_window}
544 \includegraphics[width=0.99\linewidth]{images/compositor_window.png}
545 \caption{Left hand side are the toolbar functions / bottom bar has many control functions}
546 \label{fig:compositor_window}
549 The Compositor window (figure~\ref{fig:compositor_window}) is used to display the timeline
550 output. Playing and moving along the timeline video in the Program window shows in the
551 Compositor window what the current image is. Here is where many compositing operations are
552 performed that can change
553 what the timeline will look like. When enabled, you can simply click the LMB in the Compositor
554 window to start and stop play.
555 You can zoom in and out to
556 see small details, pan with the scrollbars, lock the window to prevent changes, add masks,
557 and make changes with the Projector and Camera function operators. These will be explained
558 in more detail in the following sections.
560 \subsection{Compositor Controls}%
561 \label{sub:compositor_controls}
563 On the bottom of the window, there are many
564 of the same transport buttons and controls that are available in the Program window.
565 They work the same as in the Program window and also have tooltips that are visible
566 when you mouse over each of the icons so their use is fairly obvious. However,
567 of particular note is the button \textit{Click to play} which is described in
568 \ref{sub:click_to_play_in_viewer_and_compositor}.
570 Next to all of these controls all the way to the right side, there is a \textit{zoom menu} and a \textit{tally light}. The \textit{zoom menu} has a pulldown with different settings that you can choose from
571 or you can just use the tumbler arrows to the right. Generally when just getting started, you
572 will be using the default \textit{Auto} option. The window size is not changed, but rather
573 the size of the video itself. In addition there are many shortcuts for zooming that you
574 will find in the Shortcuts chapter (\ref{cha:shortcuts}).
576 To resize the entire window instead of just the video, use a RMB click in the compositor
577 window which brings up a menu with all the zoom levels, zoom auto mode, and some other options.
578 As you would expect, whenever the video is zoomed so that only part of the image is visible
579 in the window, scrollbars are automatically added as needed on the bottom, the right hand
581 Other options include \emph{Reset camera} and \emph{Reset projector} which obviously are used
582 to reset the camera and the projector.
583 The \emph{Hide controls/Show controls} option is great for hiding the left hand toolbar and
584 bottom set of controls for a cleaner look.
586 Next to the zoom tumbler arrows, is a \textit{tally light} that will be filled in with some color
587 (often red or blue) when a rendering operation
588 is taking place. This is especially helpful when loading a very large video so you know
589 when it is finished loading. You should pay attention to this \textit{tally light} when performing
590 a particularly time-consuming operation so that you do not keep executing more operations
591 that just have to wait until completion of that CPU intensive operation. Also, you should look
592 to see if the light is on before assuming that Cinelerra is hung up.
594 When the window is unlocked, meaning that it is not in \textit{Protect video from changes} mode on the
595 toolbar, MMB clicking and dragging anywhere in the video pans the view. Panning can also
596 be accomplished with the bottom and right hand side scroll bars when displayed.
598 \subsection{Compositor Toolbar}%
599 \label{sub:compositor_toolbar}
601 On the left hand side of the Compositor window, there is a toolbar with several icons that
602 provide functions for viewing and compositing the video. Each of these operational features
603 will be described in more detail next.
605 \item[Protect video from changes] this option makes it possible to disable changes to the
606 compositor output when clicking on the Compositor window. It allows for using the
607 \textit{Click to play} button (when enabled) for simply starting and stopping play. It helps
608 to prevent an accidental click from making unwanted changes. When you enable this option, any
609 of the other enabled tools will automatically be disabled.
611 \item[Zoom view / magnifying glass] when enabled, the \textit{Zoom view} immediately results
612 in the addition of a zoom slider for fine viewing.
613 The vertically oriented \textit{zoom slider} will be displayed underneath the last icon of the toolbar and extends
614 to almost the end of the toolbar.
615 The slider allows for adjusting the amount of zoom at any level between 0.01 and 100 based on a logarithmic scale.
617 When using the zoom slider, the number by which the view is zoomed can be seen in the textbox
618 on the bottom controls where the \% zoom is located.
619 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 the \texttt{Settings $\rightarrow$ Format} menu.
620 Once you have set the zoom to the desired size, use the vertical and horizontal scroll bars to position the view as needed.
621 As mentioned earlier, this
622 variety of zoom only affects the video and not the resizing of the Compositor window. After
623 utilizing this slider bar for zooming around, you may want to switch back to \textit{Auto}
624 using the Controls on the bottom of the window.
625 This slider bar is also displayed
626 when you click on the icons for \textit{Adjust camera automation} or \textit{Adjust projector automation}.
628 The Compositor window image in figure~\ref{fig:zoom_slider} shows the zoom slider bar with rectangular shaped slider about in the middle. Note that the magnifying glass is enabled which
629 automatically pops-up the slider and the Protect video from changes is disabled. Also note that
630 there is a scroll bar on the bottom and right side of the image since the image at this magnification
631 does not fit in the window.
632 The Controls zoom textbox shows $\times0.82$ size.
637 \includegraphics[width=0.99\linewidth]{images/zoom_slider.png}
638 \caption{Compositor window zoom slider bar and scroll bars}
639 \label{fig:zoom_slider}
643 \item[Edit mask] brings up a mask editing menu with many versatile options as
644 described in great detail later in this section (\ref{sub:masks}). You may also have to click on
645 \textit{Show tool info} to popup the menu depending on whether or not you dismissed that window previously.
646 \item[Ruler] this can be a handy tool to get the X,Y coordinates of an exact point or to
647 measure the distance between 2 points. To use the \textit{Ruler}, move the mouse on the video to
648 get to the desired spot - these X,Y coordinates will be displayed in the \textit{Current} text
649 box. Clicking the LMB creates Point 1 and then continue to hold down the LMB so that a ruler line is created between
650 this Point 1 and the stopping Point 2. \textit{Deltas} is the X,Y difference between the 2 points;
651 \textit{Distance} is the number of pixels between the 2 points; and \textit{Angle} is the angle in degrees of the ruler line.
652 In Figure ~\ref{fig:safe_regions} you can see the Ruler menu on the right side of the Compositor window.
654 Holding down the Ctrl key while dragging with the LMB on one of the points, will
655 ensure that the line is always at a multiple of a 45 degree angle. Holding down the Alt key while
656 dragging with the LMB on one of the points, will translate the ruler line to another place on
657 the video while maintaining its length and angle. If you dismiss the Ruler menu, click on
658 \textit{Show tool info} to get the menu to popup again.
659 \item[Adjust camera automation] the camera brings up the camera editing tool. Enable \textit{Show tool info} if the popup menu does not appear. More detail for usage is provided in the subsequent
660 paragraph \ref{sub:camera_and_projector}.
661 \item[Adjust projector automation] the projector brings up the projector editing tool. Enable \textit{Show tool info} to get the menu to popup again. More detail for usage is provided in the
662 subsequent paragraph \ref{sub:camera_and_projector}.
663 \item[Crop a layer or output] this is a cropping tool used to reduce the visible picture area.
664 More detail for usage is provided in a
665 subsequent paragraph (\ref{sub:cropping}). There is also a Crop \& Position plugin that provides
666 a different set of capabilities \ref{sub:crop_position}.
667 \item[Get color / eyedropper] brings up the eyedropper used to detect the color at a
668 particular spot. Enable the \textit{Show tool info} if the Color popup menu does not come up
669 automatically or if that menu was accidentally dismissed. Click on a specific color in the video
670 output with the LMB to see the selected color. You can then use that color's
671 value to be applied to some effects depending on how the effect handles the eyedropper.
672 \item[Show tool info] this tool button is used in conjunction with the other tools on the
673 compositor's toolbar. You only need to click on this if one of these tools popup menu does not
674 come up or has been dismissed - Mask, Ruler, Camera, Projector, Crop, or Eyedropper tools.
675 You can also use it when highlighted to dismiss the highlighted tool's dialog box.
676 It is not needed for Protect video from changes, Zoom view, and Show safe regions since they have
677 no dialog popup menus.
681 \includegraphics[width=0.99\linewidth]{images/safe_regions.png}
682 \caption{Note the black outlines showing the safe regions. Also note the Ruler menu}
683 \label{fig:safe_regions}
686 \item[Show safe regions] draws 2 outlines to display the safe regions in the video as you
687 can see in Figure~\ref{fig:safe_regions}.
688 On some particular TVs/monitors/displays, the borders of the image are cut off and that
689 cut off section might not be as square as it appears in the compositor window.
690 These are especially useful if the device for the output display is an older model TV.
691 The outside largest outline is the \textit{action safe overlay}; whereas the inside smallest
692 outline is the \textit{title safe overlay}.
693 Using the \textit{Show safe regions} has no affect on the rendered output.
694 The purpose of showing the borders is to make it easy to see where it might be cut off. This
695 area outside the safe region can then be used as
696 a scratch or vertical blanking space. Enabling the safe regions makes it really
697 easy to see these borders so that you can make sure
698 titles are inside the inner outline and actions are inside the outer outline.
702 \subsection{Compositing}%
703 \label{sub:compositing}
705 A large amount of Cinelerra's editing is directed towards compositing.
706 Changing the resolution of a show, making a split screen, and fading in and out among other things are all compositing operations in Cinelerra.
707 Cinelerra detects when it is in a compositing operation and plays back through the compositing engine only then.
708 Otherwise, it uses the fastest decoder available in the hardware.
710 Compositing operations are done on the timeline and in the Compositor window. Shortcuts exist in the Resource window for changing some compositing attributes.
711 Once some video files are on the timeline, the compositor window is a good place to try compositing.
713 \subsection{Camera and Projector}%
714 \label{sub:camera_and_projector}
716 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.
717 Cinelerra's compositing routines use a \textit{temporary}, a frame of video in memory where all graphics processing is performed.
718 Inside Cinelerra's compositing pipeline, the camera determines where in the source video the \textit{temporary} is copied from.
719 The projector determines where in the output the \textit{temporary} is copied to (figure~\ref{fig:temporary-01}).
720 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.
724 \includegraphics[width=0.8\linewidth]{images/temporary-01.pdf}
725 \caption{Compositing pipeline}
726 \label{fig:temporary-01}
729 In compositing, each frame can be digitally altered using various options, such as a color correction plugin (figure~\ref{fig:camera_and_projector}).
730 Once the image has been transformed, the finished image is then projected to the compositor thus creating a modified version of the original.
734 \includegraphics[width=0.8\linewidth]{images/camera_and_projector.png}
735 \caption{Color balance on Temporary}
736 \label{fig:camera_and_projector}
739 When editing the camera and projector in the compositing window, the first track with record enabled is the track affected.
740 Even if the track is completely transparent, it is still the affected track.
741 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.
742 This solos the track.
744 The purpose of the projector is to place the contents of the \textit{temporary} into the project's output.
745 The intent of the projector is to composite several sources from the various tracks into one final output track.
746 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.
748 \subsubsection*{Compositing projector controls}%
749 \label{ssub:compositing_projector_controls}
751 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.
753 \subsubsection*{Viewport sizes}%
754 \label{ssub:viewport_sizes}
756 The viewport is a window on the camera that frames the area of source video to be scanned.
757 The initial size of the viewport is defined by the size of the current track. A smaller viewport ($640\times400$) captures a smaller area.
758 A larger viewport ($800\times200$) captures an area larger than the source video and fills the empty spaces with blanks.
759 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:
762 \item Open the compositor window with a track selected.
763 \item Select the camera button to enable camera editing mode.
764 \item Drag over the display window.
767 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.
769 \subsubsection*{Compositing camera controls}%
770 \label{ssub:compositing_camera_controls}
772 Select the camera button to enable camera editing mode.
773 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.
774 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.
776 \subsubsection*{The camera and projector tool window}%
777 \label{ssub:the_camera_and_projector_tool_window}
779 The camera and projector have shortcut operations that do not appear in the popup menu and are not represented in video overlays.
780 These are accessed in the \emph{Show tool info} window .
781 Most operations in the Compositor window have a tool window which is enabled by activating the question mark icon (figure~\ref{fig:camera_tool}).
783 \begin{wrapfigure}[12]{O}{0.3\linewidth}
785 \includegraphics[width=0.9\linewidth]{images/camera_tool.png}
786 \caption{Camera and Projector tool}
787 \label{fig:camera_tool}
790 In the case of the camera and projector, the tool window shows $x$, $y$, and $z$ coordinates.
791 By either tumbling or entering text directly, the camera and projector can be precisely positioned.
792 Justification types are also defined for easy access.
793 A popular justification operation is upper left projection after image reduction.
794 This is used when reducing the size of video with aspect ratio adjustment.
795 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.
797 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.
798 The track size is set to the original size of the video and the camera is centered.
799 The output size is set to the reduced size of the video.
800 Without any effects, this produces just the cropped center portion of the video in the output.
802 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.
803 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.
804 Instead, we leave out $x$ and out $y$ at 0 and use the projector's tool window.
805 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.
807 \subsubsection*{Reset to Default}%
808 \label{ssub:reset_default}
810 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:
812 \textit{Reset Camera}: causes the camera to return to the center position.
814 \textit{Reset Projector}: causes the projector to return to the center.
816 \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}}}%
817 \label{ssub:use_case_interaction_camera_projector}
820 \item Start by shrinking the projector to $z=0,500$ ($\frac{1}{4}$ of the original frame).
821 \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.
822 \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.
823 \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.
824 \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.
830 Masks select a region of the video for either displaying or hiding.
831 Masks are also used in conjunction with another effect to isolate the effect to a certain region of the frame.
832 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.
833 Color correction may be needed in one subsection of a frame but not another.
834 A mask can be applied to just a subsection of the color corrected track while the plain track shows through.
835 Removal of boom microphones and airplanes are a common kind of mask uses.
837 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.
839 The compositing pipeline graph has a masking stage (figure~\ref{fig:temporary-02}).
843 \includegraphics[width=0.7\linewidth]{images/temporary-02.pdf}
844 \caption{compositing pipeline with mask}
845 \label{fig:temporary-02}
848 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.
850 \subsubsection*{Compositing pipeline with masks}%
851 \label{ssub:compositing_pipeline_with_masks}
854 \item To define a mask, go into the Compositor window and enable the mask toggle.
855 \item Next go over the video and click-drag.
856 Note: You have to select automatic keyframes if you wish to move a mask over time.
857 If you do not, the mask position will be the same even if you edit at different places on the timeline.
858 \item Click-drag again in another part of the image to create each new point of the mask.
859 While it is not the conventional Bezier curve behavior, this masking interface performs in realtime what the effect
860 of the mask is going to be. Creating each point of the mask expands a rubber band curve.
862 Once points are defined, they can be moved by Ctrl-dragging in the vicinity of the corner.
863 Shift-drag allows you to move existing points to new locations, thus altering the shape of the mask.
864 However, this does not smooth out the curve.
865 The end points of the Bezier curve are accessed by Ctrl-dragging in the vicinity of the corner.
866 Then Ctrl-dragging near the end point causes the point to move.
867 Shift-drag activates bezier handles (control points) to create curves between mask points.
869 \item Finally once you have a mask, the mask can be translated in one piece by Alt-dragging the mask.
870 The effect of the mask is always on.
871 Ctrl-Alt-drag translates an entire mask to a new location on the
875 The masks have many more parameters which could not be represented with video overlays.
876 These are represented in the tool window for masks.
877 Selecting the question mark when the mask toggle is highlighted brings up the mask options window (figure~\ref{fig:mask_window}).
881 \includegraphics[width=0.5\linewidth]{images/mask_window.png}
882 \caption{Mask options window}
883 \label{fig:mask_window}
886 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.
888 \subsubsection*{Masks on Track section}%
889 \label{ssub:masks_track_section}
891 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.
893 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.
895 \subsubsection*{Masks section}%
896 \label{ssub:masks_section}
898 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.
900 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.
902 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.
904 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}.
906 \subsubsection*{Preset Shapes section}%
907 \label{ssub:preset_shape_section}
909 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.
911 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.
913 \subsubsection*{Position \& Scale section}%
914 \label{ssub:position_scale_section}
916 \textit{Center} mask button allows for quickly centering a mask on the video track.
917 \textit{Normalize} mask button makes it easy to normalize the size of the mask based on the scale of the video.
918 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.
920 \texttt{xlate/scale x} - drag translate constrained in the $X$ direction
922 \texttt{xlate/scale y} - drag translate constrained in the $Y$ direction
924 \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.
926 \subsubsection*{Fade \& Feather section}%
927 \label{ssub:fade_feather_section}
929 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.
931 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:
933 Note1: The area outside the mask is referred to as the background.
935 Note2: The operational result is based on the maximum transparency value of that background.
937 \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
938 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.
940 \paragraph{Case 2, Negative Fade:} When the program computes the background color for any number of masks that includes negative
941 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.
943 \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.
945 \subsubsection*{Mask Points section}%
946 \label{ssub:masks_points_section}
948 This section is used to change to a different mask number and manipulate the masks you have created.
950 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.
952 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.
954 \textit{smooth point} $\rightarrow$ smooth a single point.
956 \textit{smooth curve} $\rightarrow$ smooth all points on a mask edge curve.
958 \textit{smooth all} $\rightarrow$ smooth all active masks.
960 Linear buttons of \textit{linear point}, \textit{linear curve}, and \textit{linear all}, perform the inverse of the smooth functions.
961 The control point vectors on the bezier endpoints are set to zero magnitude.
963 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.
965 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.
967 \subsubsection*{Pivot Point section}%
968 \label{ssub:pivot_point_section}
970 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.
972 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.
974 \subsubsection*{Other sections}%
975 \label{ssub:other_sections}
977 Finally there are the \textit{Apply masks before plugins} and \textit{Disable OpenGL masking} self-explanatory checkboxes.
979 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.
981 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:
984 \begin{tabular}{ l l }
986 Shift+LMB & move an end point \\
987 Ctrl+LMB & move a control point \\
988 Alt+LMB & to drag translate the mask \\
989 Shift+MMB & set Pivot Point at pointer \\
990 Wheel & rotate around Pivot Point \\
991 Ctrl+Shift+Wheel & scale around Pivot Point \\
992 Ctrl+Wheel & rotate/scale around pointer \\
996 \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.
999 \begin{tabular}{ l p{11cm}}
1001 LMB & move/create an end point (to move the end point the pointer must be above the point) \\
1002 Shift+LMB & move an end point (the pointer may be near the point, not above it) \\
1003 Ctrl+LMB & move/create a control point \\
1004 Alt+Ctrl+LMB & to drag translate the mask \\
1005 Shift+Key Delete & to delete the mask \\
1006 Shift+MMB & Set Pivot Point at pointer \\
1007 Alt+Wheel & zoom in/out the screen (also available in Ubuntu16 but does not exist in all distros) \\
1012 Focus checkbox = unchecked:
1015 \begin{tabular}{ l l }
1017 Wheel & rotate around Pivot Point \\
1018 Shift+Wheel & scale around Pivot Point \\
1019 Ctrl+Wheel & rotate around pointer \\
1020 Ctrl+Shift+Wheel & scale around pointer \\
1026 Focus checkbox = checked:
1029 \begin{tabular}{ l l }
1031 Wheel & rotate around Pivot Point (“Custom focus point”) \\
1032 Shift+Wheel & scale around Pivot Point (“Custom focus point”) \\
1037 Note: in order to be able to rotate/scale around pointer, the Focus checkbox must be unchecked.
1039 \subsection{Cropping}%
1040 \label{sub:cropping}
1042 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.
1045 The easiest way to use cropping is to click with the LMB at the spot
1046 to begin cropping and while holding down the LMB drag. This creates a rectangular cropping area.
1047 To change the size/location of that area, click on any of the 4 corner points with the LMB
1049 Note the X1,Y1 coordinates and W for width, H for height, in the Crop tool popup menu
1050 automatically will change numerical value to reflect your dragging. For precise locations, you
1051 can keyin exact values into those textboxes.
1052 Once you have the crop are defined as you want it, then click on the Apply button to have the
1053 actual cropping take affect.
1054 There are 3 choices of capabilities to choose in the menu pulldown on the bottom right side.
1055 Reformat (or Reformat Session) which crops and changes the Format for the session.
1056 Because the Format is changed, this is applied to all tracks in the project.\\
1057 Resize (or Resize Projector)\\
1058 Shrink (or Resize Projector and Camera).\\
1059 An important note here is that the original aspect ratio will be maintained so if your frame is rectangular (as many are) and you "crop" by surrounding the region of interest with a square, the cropped are will be more than you marked in order
1060 to keep the aspect rectangular shape.
1061 The Resize and Shrink options are applicable to all video tracks except the disarmed ones.
1062 This is in contrast to the Reformat option, as mentioned previously, which applies to all tracks even if disarmed because it changes the Format for the session.
1063 One last note of interest, this cropping is keyframable.
1066 \begin{figure}[htpb]
1068 \includegraphics[width=0.5\linewidth]{images/cropped_area.png}
1069 \caption{Cropped area is in the top right corner}
1070 \label{fig:cropped_area}
1074 \item Enable the crop toggle and the tool window in the compositor window to display the Crop control dialog box.
1075 \item Click-drag anywhere in the video to define the crop area. This draws a rectangle over the video.
1076 \item Click-drag anywhere in the video to start a new rectangle.
1077 \item Click-drag over any corner of the rectangle to reposition the corner.
1078 \item Alt-click in the cropping rectangle to translate the rectangle to any position without resizing it.
1079 \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.
1080 \item The \textit{Set Format} window will show the new project Width and Height values.
1081 \item The projector tool window will show the new $X, Y$ values.
1082 \item Track size will remain unchanged.
1085 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.
1087 \subsection{Track and Output Sizes}%
1088 \label{sub:track_and_output_sizes}
1091 The size of the temporary and the size of the output in our compositing pipeline are independent and variable.
1092 The camera's viewport is the temporary size.
1093 Effects are processed in the temporary and are affected by the temporary size.
1094 Projectors are rendered to the output and are affected by the output size.
1095 If the temporary is smaller than the output, the temporary is bordered by blank regions in the output.
1096 If the temporary is bigger than the output, the temporary is cropped.
1098 \subsubsection*{Track size}%
1099 \label{ssub:track_size}
1101 The temporary size is defined as the track size.
1102 Each track has a different size.
1103 Right click on a track to bring up the track's menu.
1104 Select \emph{Resize Track} to resize the track to any arbitrary size.
1105 Alternatively you can select \emph{Match output size} to make the track the same size as the output.
1106 If you resize a track, then its appearance on the compositor changes accordingly.
1107 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.
1109 \subsubsection*{Output size}%
1110 \label{ssub:output_size}
1113 The output size is set in either \texttt{File $\rightarrow$ New} when creating a new project or \texttt{Settings $\rightarrow$ Format}.
1114 In the Resources window there is another way to change the output size.
1115 Right click on a video asset and select \emph{Match project size} to conform the output to the asset.
1116 When new tracks are created, the track size always conforms to the output size specified by these methods.
1118 When rendering, the project's output size is the final video track size where the temporary pipeline is rendered into.
1119 If the output size is larger than the temporary then the image transferred from the temporary will fit inside the Output Track.
1120 Any space left on the Output is left blank.
1121 If the output size is smaller than the temporary then some of the temporary video will be cropped.
1123 \section{Viewer Window}%
1124 \label{sec:viewer_window}
1126 The viewer window (figure~\ref{fig:viewer_window}) is a place to load and preview your source media and clips.
1127 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.
1129 \begin{figure}[htpb]
1131 \includegraphics[width=0.99\linewidth]{images/viewer_window.png}
1132 \caption{Viewer Window}
1133 \label{fig:viewer_window}
1136 To open the viewer window, go to \texttt{Window $\rightarrow$ Show Viewer}.
1137 The display is the area on the viewer where you actually see media playing.
1138 Before you can play any media, you must first load it on the viewer.
1139 To load media into the viewer:
1142 \item Open the resources manager window and select the Media folder or the Clip folder.
1143 \item Drag a file from the Media or the Clip folder to the viewer.
1146 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.
1147 Once your media loads you will see it appear on the display.
1148 To play, rewind or forward through it use the slider control or the transport controls.
1149 You can change the media display size by right clicking on the screen to activate the display zoom menu.
1150 Select zoom levels of 50\%, 100\% or 200\% of the original media size.
1152 When displaying media, the viewer uses the project's defined output size format settings, not the original assets format.
1153 You can change the project's output to match the asset's format using the match project size menu option in the asset manager.
1154 In the Viewer you can move around in the source media or clips and select regions to paste into the project.
1155 Operations done in the viewer affect a temporary EDL or a clip, but not the timeline.
1157 \section{Options in both the Compositor and Viewer Windows}%
1158 \label{sec:options_in_both_the_compositor_and_viewer_windows}
1160 The next sections describe capabilities that are available in both the Compositor and Viewer windows.
1162 \subsection{Click to Play in Viewer and Compositor}%
1163 \label{sub:click_to_play_in_viewer_and_compositor}
1165 In both the Viewer and Compositor windows, there is an arrow on the right hand side of the other buttons in the edit panel.
1166 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.
1167 When enabled there is a gold-colored shadow around the usual green-colored arrow.
1168 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.
1169 The entire main canvas surface becomes a big play button!
1170 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.
1173 \item[left click] forward play or stop forward play if already playing
1174 \item[middle wheel] single frame forward or back
1175 \item[middle click] reverse play or stop reverse play if already playing.
1176 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}.
1179 \subsection{Timebar + Preview Region Usage in the Compositor and Viewer}%
1180 \label{sub:timebar_preview_region_usage_in_the_compositor_and_viewer}
1182 The navigation features of the Viewer and Compositor behave very similarly.
1183 Each has a timebar and slider below the video output.
1184 The timebar represents the entire time covered by the program.
1185 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.
1187 Labels and In/Out points are fully supported in the viewer and compositor.
1188 In the viewer and compositor, labels and in/out points are displayed in the timebar.
1189 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.
1190 When you hit the label button in the compositor, the label appears both in the compositor timebar and the program timebar.
1191 When you select a label or in/out point in the compositor, the insertion point in the program window jumps to that position.
1193 The timebar in the compositor and the viewer can be used to define a region known as the \textit{preview region}.
1194 This preview region is the region of the timeline which the slider affects.
1195 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.
1196 The preview region can be especially handy when you have large pieces of media by previewing one section, then move to the next section.
1198 The active preview region is the zone between the edge bars.
1199 The full range of the window slider pointer action is down-scaled to the active preview region.
1200 To use this, set the preview active region as a media time region of interest.
1201 Now addressing the timebar with the mouse only operates as if the timebar is zoomed to the scale of the active preview zone.
1202 This has the effect of magnifying the interesting media in terms of the mouse pointer addressing, for fine-tuning.
1204 \begin{figure}[htpb]
1206 \includegraphics[width=0.8\linewidth]{images/timebar1.png}
1207 \caption{The arrow above the green colored “play forward” transport button is on the timebar.}
1208 \label{fig:timebar1}
1211 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.
1212 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.
1213 The slider will be a light blue color while the selected preview region will remain the same initial black color.
1214 There are either a left or right resize pointer and you can click and drag in either direction to expand or shrink the region.
1216 \begin{figure}[htpb]
1218 \includegraphics[width=0.8\linewidth]{images/timebar2.png}
1219 \caption{ A left-facing arrow on the right side of the blue slider bar is used to drag the bar.}
1220 \label{fig:timebar2}
1223 \begin{figure}[htpb]
1225 \includegraphics[width=0.8\linewidth]{images/timebar3.png}
1226 \caption{Here you can see the right-facing arrow used to drag the other end of the slider bar.
1227 The black area between is the actual preview area.}
1228 \label{fig:timebar3}
1231 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.
1232 The selected area will move left or right as you drag and still retains the same size.
1234 \begin{figure}[htpb]
1236 \includegraphics[width=0.8\linewidth]{images/timebar4.png}
1237 \caption{Note the double-headed fat arrow in the preview area used to move the selection over.}
1238 \label{fig:timebar4}
1244 \item If no preview region is set, increasing the length of the media on the timeline by inserting media or
1245 appending, has no effect on the non-selected preview region. That is, you will not see the blue slider
1246 suddenly mysteriously appear.
1247 \item If the preview region is set, when you replace the current project or file, the preview region is
1248 automatically disabled.
1249 \item If the preview region is set, when you append data or change the size of the current project, the
1250 preview region may appear to either move, shrink, or grow depending on the new length of the
1251 media on the timeline.
1252 \item To disable the preview region, you will have to drag both the right and the left blue slider bars
1253 completely to their corresponding end so that there is no longer any visible blue slider.
1256 A good method for taking advantage of the preview region is described here.
1257 On the main track canvas, scroll to the beginning of the area of interest.
1258 When you do that, you will see in the compositor the red indicator line of that location.
1259 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.
1260 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.
1261 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.
1263 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.
1265 \section{Resources Window}%
1266 \label{sec:resources_window}
1268 Effects, transitions, labels, clips, proxies, user bins, and media assets are accessed here.
1269 Most of the resources are inserted into the project by dragging them out of the resource window.
1270 Management of resource allocation is also performed here.
1272 \begin{figure}[htpb]
1274 \includegraphics[width=0.7\linewidth]{images/resource_window.png}
1275 \caption{Folders are in the first column with contents of that folder on the right hand side}
1276 \label{fig:resource_window}
1279 The resources window is divided into two areas (figure~\ref{fig:resource_window}.
1280 One area lists folders and another area lists the folder contents.
1281 Going into the folder list and clicking on a folder updates the contents area with the contents of that folder.
1282 The folders can be displayed as icons or text.
1283 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.
1284 Use the letter “\texttt{V}” to easily scroll through the choices and see which you prefer.
1285 You can also get to these options from the menu by a right mouse click in the window.
1287 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).
1288 As you type in characters a match is made with that substring.
1289 Names that do not match are filtered out making it a lot easier to find the item you are looking for.
1290 The characters can be any where within the phrase and it does not matter if upper or lower case.
1292 Other options you will see if you \textit{right mouse click in the folder} which brings up the menu are described next.
1295 \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.
1296 \item[Display text/icons] as described previously for format variations preference.
1297 \item[Select] options are All, Used, Unused, and None. This gives you the capability to have a set of the
1298 contents highlighted for ease of use so you can see what is or is not loaded, or unset the highlight.
1299 \item[Sort items] to sort the contents of the folder alphabetically. Especially helpful if you accidentally did a
1300 drag and changed your mind or dropped suddenly so that the assets no longer look nicely aligned.
1301 \item[Copy/Paste file list] use to easily copy a set of files or paste a set of files between Cin and windows.
1302 \item[Snapshot/Grabshot] described elsewhere in more detail.
1305 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.
1307 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.
1308 You can highlight several for some options so that it is applicable to all of them, such as Info.
1309 Those listed immediately below are the available choices for media assets.
1313 \item[Info] provided basic Asset information; details are described later in this section.
1314 \item[Display text/icons] same as mentioned previously.
1315 \item[Sort] same as mentioned previously.
1316 \item[Rebuild index] if you switch from/to using ffmpeg/native for media loading, you should rebuild
1317 indexes. Or if you get hangs on media or strange looking tracks, you might want to rebuild indexes.
1318 \item[View] use this option to bring up the media in the Viewer window.
1319 \item[View in new window] in order to not overwrite your current viewer window, you can open any
1320 number of viewer windows to simultaneously view multiple media.
1321 \item[Open mixers] when you record with multiple cameras setup, you can work with them most easily
1322 using the mixer mode. This is described in detail
1324 \item[Match] if you need to change your media parameters you can choose from the following: Match frame
1325 rate, Match project size, Match all
1326 \item[Remove] use to Remove the asset from the project or with caution, to Remove from disk permanently.
1329 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.
1330 For Labels, choices are \emph{Edit}, \emph{Label}, and \emph{Go to}.
1331 For Clips, \emph{Nest} and \emph{UnNest} as described elsewhere are available.
1333 \subsection{Info Asset Details}%
1334 \label{sub:info_asset_details}
1336 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.
1337 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.
1339 \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}.
1341 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.
1343 \begin{figure}[htpb]
1345 \includegraphics[width=0.99\linewidth]{images/info_asset_details.png}
1346 \caption{The “Detail” box}
1347 \label{fig:info_asset_details}
1350 \subsection{User Folders/Bins}%
1351 \label{sub:user_folders_bins}
1353 Creating folders that are more specific to a particular project is helpful in better organizing your work.
1354 This can be done by utilizing the files already loaded to the \textit{master} Media or Clips folders in the Resources window.
1355 Below are steps illustrating an easy way to set up a folder.
1357 %TODO Below part need to be rewriten
1359 \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.
1360 Highlight, then click \textit{New Media or Clips}.
1361 \begin{figure}[htpb]
1362 \begin{minipage}{.55\linewidth}
1364 \includegraphics[width=0.9\linewidth]{images/folder_resources.png}
1365 \caption{Highlight, then click “New Media or Clips”.
1366 “Modify folder” can be used to change the name of a folder.
1367 “Delete folder” in the popup can be used to delete a folder.
1369 \label{fig:folder_resources}
1372 \begin{minipage}{.35\linewidth}
1376 \includegraphics[width=0.9\linewidth]{images/folder_new.png}
1377 \caption{Type in your folder name in the textbox. Click OK.}
1378 \label{fig:folder_new}
1381 \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.
1382 \begin{figure}[htpb]
1385 \item Select the \textit{master} Media folder to see which files are currently loaded, figure~\ref{fig:folder_master}.
1386 Highlight the files there that you want to copy to your new folder (named Photos of Garden).
1387 Drag the files to the left and when you see the Photos of Garden folder become highlighted, then drop there.
1388 You can drag and drop any of the media from the \textit{master} Media at any time.
1389 It flashes when the drop is successful.
1392 \begin{wrapfigure}[12]{O}{0.53\linewidth}
1395 \includegraphics[width=0.9\linewidth]{images/folder_master.png}
1396 \caption{The “master” Media folder}
1397 \label{fig:folder_master}
1400 Adding the Shift key before the actual drop, will allow for relative path filenames instead of full path.
1401 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.
1402 In this case you will want to click on the \textit{Modify folder} in the popup.
1403 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.
1406 \begin{figure}[htpb]
1408 %\includegraphics[width=0.8\linewidth]{name.ext}
1409 \begin{tikzpicture}[scale=1, transform shape]
1410 \node (img1) [yshift=0cm, xshift=0cm, rotate=0] {\includegraphics[width=0.7\linewidth]{images/folder_modify.png}};
1411 \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 }};
1412 \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.}};
1413 \draw [->, line width=1mm] (Arrow1) edge ([yshift=-31mm] img1.north west);
1416 \caption{Modify target}
1417 \label{fig:modify-target}
1420 To delete the entire set of files listed on the filter rule, highlight the rule line and hit the \textit{Del} button.
1421 To add a new filter rule, click on the \textit{Add} button which will automatically add a default line after any current lines.
1422 The default line will be a line that matches everything in the \textit{master} Media folder which is \textit{Or Patterns Matches *}.
1423 Click the right mouse button on the current field underneath the column header to see the choices available for each column.
1425 Modifications will not be in effect until you click on the green arrow OK button or click on the Apply button.
1426 But once you hit Apply, clicking on the red X button will not undo your changes.
1427 The filter/search rules are applied in the order listed in the Modify folder window.
1428 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.
1430 The figure~\ref{fig:modify_folder} below displays the available choices for each field.
1432 \begin{figure}[htpb]
1434 %\includegraphics[width=0.8\linewidth]{name.ext}
1435 \begin{tikzpicture}[scale=1, transform shape]
1436 \node (img1) [yshift=0cm, xshift=0cm, rotate=0] {\includegraphics[width=0.6\linewidth]{images/modify_folder1.png}};
1437 \node (img2) [yshift=-1cm, xshift=4cm, rotate=0] at (img1) {\includegraphics[width=0.6\linewidth]{images/modify_folder2.png}};
1438 \node (img3) [yshift=-1cm, xshift=3cm, rotate=0] at (img2){\includegraphics[width=0.3\linewidth]{images/modify_folder3.png}};
1440 \caption{The available choices for each field}
1441 \label{fig:modify_folder}
1444 Information about the columns and rules for the search filters in the Modify folder window follows.
1449 \item[ Enable] this column is used to designate the state of that filter rule
1451 \item[ Off] disable the filter
1452 \item[And] narrow your search; all of your search terms must be present
1453 \item[Or] broaden your search to include more values
1454 \item[And Not] exclude terms that do not contain the given value from your search results
1455 \item[Or Not] include terms that do not contain the given value from your search results
1457 \item [Target] – this column designates which media asset attribute to look at
1459 \item[ Patterns] each line contains a filename filter, matches the file path
1460 \item[Filesize] number of bytes in a file
1461 \item[Time] date file was created
1462 \item[Track Type] track type of video, audio, or audio video (for both)
1463 \item[Width] Format width
1464 \item[Height] Format height
1465 \item[Framerate] Video framerate
1466 \item[Samplerate] Audio samplerate
1467 \item[Channels] Number of audio channels
1468 \item[Duration] Playback time in seconds -- it uses the largest of audio or video if contains both
1470 \item[Op] – boolean operators used to narrow or broaden the relationship between your search terms
1472 \item[Around] about this value; use \textit{+radius} for a search range: [target–radius$\dots$ target+radius]
1474 \item[Ge] greater than or equal to
1475 \item[Gt] greater than
1477 \item[Le] less than or equal
1479 \item[Matches] exactly matches for strings
1483 \textbf{Value} --- the characteristic you are looking for with expressions that can be written with the following:
1486 \item[Number] (decimal points are allowed and will be converted to a standard form):
1488 \item[inf] representing infinity
1489 \item[\#[TtGgMmKk]] --- where \# represents a number and the characters mean:
1492 \begin{tabular}{rcl}
1511 \begin{tabular}{rcl}
1513 date&=&year/month/day\\
1514 time&=&hour:minute\\
1515 time&=&hour:minute:second\\
1516 date\_time&=&date time\\
1520 \begin{tabular}{rcl}
1521 day &=& \#day | \#days\\
1522 week &=& \#week | \#weeks\\
1523 month&=& \#month | \#months\\
1524 year &=& \#year | \#years\\
1527 delta&=&hours:mins:secs\\
1533 \item[Around length:]
1538 Table showing the allowed usage:
1540 %TODO create table for below code
1541 \begin{lstlisting}[numbers=none]
1542 target: | eq ge gt ne le lt matches around
1543 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++
1544 patterns | <---- strcmp ---------> + filter + nearest
1545 file_size | <---- arithmetic -------+------> + radius
1546 mod_time | <---- arithmetic -------+------> + radius
1547 track_type | <---- member test ------+--------+------>
1548 width | <---- arithmetic -------+------> + radius
1549 height | <---- arithmetic -------+------> + radius
1550 framerate | <---- arithmetic -------+------> + radius
1551 samplerate | <---- arithmetic -------+------> + radius
1552 channels | <---- arithmetic -------+------> + radius
1553 duration | <---- arithmetic -------+------> + radius
1556 where in the above, the filter can be:
1558 \begin{tabular}{rcl}
1562 list&=&[token]list\\
1563 string&=&<chars>|<empty>\\
1565 token&=&string*token\\
1568 Examples with some caveats first:
1571 \item \textit{Or} generally includes or adds whereas \textit{And} generally excludes or subtracts.
1572 \item The filters only work on media in the folder; if there is no media, then there is nothing to search.
1573 \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.
1574 \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.
1582 \begin{tabular}{llllm{10em}} \toprule
1583 Enable& Target& Op& Value& meaning\\\midrule
1584 Or &Patterns &Matches &*& all files from the Media folder are included\\
1585 And Not&Filesize&Lt &160000000& no files that are less than 160MB in size \\
1586 Or Not& Time &Ge &2018/07/30 06:13:00 & files not greater than or equal date\\
1587 And &Duration&Eq &01:00 & files included must have 60 secs. Duration\\
1588 Off &Samplerate&Ne &44000 & off for now, but may want to include later\\
1589 And &Framerate&Around&24+1 & files included all have 24 to 25 framerate\\
1590 Or &Patterns&Matches&[*.mp4] & all files with the extension of mp4\\
1591 Or &Time& Around&2018/08/02 06:00:00 + 02:00:00 & files at 4AM to 8 AM\\\bottomrule
1596 \subsection{Vicons \& Aicons – aka Video Icons / Audio Icons}%
1597 \label{sub:vicons_aicons_aka_video_icons_audio_icons}
1599 Vicons are video icons.
1600 Aicons are audio icons.
1601 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}).
1602 This is enabled for the Media/Proxy folders in icon mode when the mouse pointer is inside the Resources window.
1604 \begin{figure}[htpb]
1606 \includegraphics[width=0.99\linewidth]{images/vicons1.png}
1607 \caption{Note "Full Play" mode and Vicons and Aicons in Media folder}
1611 The waveform in the figure~\ref{fig:vicons2} is displayed in the Resources window in the color green/yellow for the 2 audio tracks.
1612 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.
1613 There are various other colors between these colors same as that seen in the color spectrum in the screenshot below.
1614 Colors are utilized from the hue wheel in the counter-clockwise direction.
1615 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.
1619 \begin{figure}[htpb]
1621 %\includegraphics[width=0.8\linewidth]{name.ext}
1622 \begin{tikzpicture}[scale=1, transform shape]
1623 \node (img1) [yshift=0cm, xshift=0cm, rotate=0] {\includegraphics[width=0.99\linewidth]{images/vicons2.png}};
1624 \node (img2) [yshift=0cm, xshift=2.8cm, rotate=0] at (img1.south west) {\includegraphics[width=0.3\linewidth]{images/hue_wheel.png}};
1625 \node [yshift=-5mm, xshift=1cm,anchor=west] at (img2.east) (Arrow1) {\parbox{18em}{Color hue wheel. For illustration only}};
1626 \draw [->, line width=1mm] (Arrow1) edge ([yshift=-5mm] img2.east);
1628 \caption{Draw Vicons | Screenshot display various audio file lengths; red is shortest.}
1632 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.
1635 \subsection{Resources Window Preview Mode}%
1636 \label{sub:resources_window_preview_mode}
1639 Preview mode can be used to pop up a window which draws the vicons/aicons thumbnails in a larger size.
1640 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.
1641 The Preview mode/playback toggle is to the right of the Visibility label as seen in the screenshot above.
1642 Preview mode is available for the Media, Proxy, Media User Bins, and Clips but clips are only 1 image.
1644 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.
1645 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.
1646 To conserve memory, the video is stored 8\,bits per pixel which results in low image quality while the audio is 16\,bit.
1647 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.
1648 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.
1649 You can increase the thumbnail size, clarity of pixels (memory size) and color mode but it takes a lot more memory.
1650 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.
1651 You can also temporarily increase the preview mini-window by use of the mouse wheel up or down.
1653 There are 4 options for the preview mode.
1656 \item \emph{Full Play} is the default mode.
1657 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.
1658 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.
1659 \emph{Full Play} includes the \emph{Mouse Over} capabilities as described below as well as the Inter-View \emph{Src Target} functions.
1661 \item \emph{No Play} mode is especially useful on smaller computers and for users who find the constant loop play to be somewhat distracting.
1663 \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.
1664 Once activated, whenever you just move the mouse over an icon, it automatically pops up the increased size preview.
1665 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.
1666 \emph{Mouse Over} mode makes it quick and easy to preview without having to drag the media to the viewer.
1667 You can still drag the media same as without preview enabled.
1669 \item \emph{Src Target} mode gives easy access to the Inter-View source target available by using the middle mouse button on media.
1670 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.
1671 \emph{Src Target} mode in any scenario never plays sound as that is nonsensical usage.
1672 After the initial click to pop media in this mode, you also have the \emph{Mouse over} feature.
1675 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.
1676 This helps to avoid having the thumbnail get in the way of dragging or other functions.
1677 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.
1679 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.
1681 \begin{figure}[htpb]
1682 \begin{minipage}{.69\linewidth}
1684 \includegraphics[width=0.99\linewidth]{images/preview_icon_mode.png}
1685 \caption{The location of the Preview/Draw Icons mode.}
1686 \label{fig:preview_icon_mode}
1689 \begin{minipage}{.29\linewidth}
1692 \includegraphics[width=0.7\linewidth]{images/line_through_mode.png}
1693 \caption{Note the line through the mode.}
1694 \label{fig:line_through_mode}
1700 \subsection{Moving clips/media from/to Resources window}%
1701 \label{sub:moving_clips_media_from_to_resources_window}
1703 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:
1705 Copy or paste a list of files in the Media Resources window:
1709 \item create a highlighted selection of the desired media files in the media Resources window
1710 \item right click on an unused portion of that window to bring up the popup menu
1711 \item select the \textit{Copy file list} item and a file list box will appear that contains the full path filenames
1712 \item wipe the textbox using your standard copy/paste method to put the list of files in the copy buffer
1713 \item in another Cinelerra instance, choose the \textit{Paste file list} of the media Resources window
1714 \item paste the list of files, again using your standard paste method, into the new file list box; press OK
1715 \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).
1718 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.
1720 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.
1721 Since the procedure varies among the distros, you will have to adapt to your specific one. For example, a usage for ubuntu consists of:
1723 \setcounter{enumi}{3}
1724 \item Ctrl-c to copy the list of files; open gedit; Ctrl-v to paste the list of files into gedit
1725 \item Ctrl-c or the standard way using the right click to copy this list from gedit
1726 \item Ctrl-v paste the list of files into the new file list box, and press OK
1729 \begin{figure}[htpb]
1731 \begin{minipage}{.49\linewidth}
1733 \includegraphics[width=0.99\linewidth]{images/copy_files1.png}
1736 \begin{minipage}{.49\linewidth}
1738 \includegraphics[width=0.99\linewidth]{images/copy_files2.png}
1740 \caption{Example of copy file list}
1741 \label{fig:copy_files1}
1744 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.
1745 Note how it includes the full pathname.
1747 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.
1750 Another possible usage of this capability:
1753 \item Right Click on the Clips Resources window and use the \textit{Paste Clip} option to paste the Copy selection as a clip.
1754 \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.
1758 \subsection{Snapshot / Grabshot}%
1759 \label{sub:snapshot_grabshot}
1761 \begin{figure}[htpb]
1763 \begin{minipage}{.49\linewidth}
1765 \includegraphics[width=0.8\linewidth]{images/snapshot.png}
1766 \caption{Snapshot menu and choices}
1767 \label{fig:snapshot}
1769 \begin{minipage}{.49\linewidth}
1771 \begin{tikzpicture}[scale=1, transform shape]
1772 \node (img1) [yshift=0cm, xshift=0cm, rotate=0] {\includegraphics[width=0.65\linewidth]{images/grabshot.png}};
1773 \node (img2) [yshift=2cm, xshift=-1cm, rotate=0] {\includegraphics[width=0.07\linewidth]{images/reticle.png}};
1775 \caption{Grabshot reticle \& orange box}
1776 \label{fig:grabshot_recticle}
1780 To take a snapshot, perform the following steps:
1783 \item set your timeline insert marker where you want the snapshot -- this frame shows in the compositor
1784 \item right click in an empty spot in the media folder and the popup shows snapshot as the $5^{th}$ item down
1785 \item highlight that and the submenu comes up allowing you to choose png, jpg, ppm or tiff
1788 The snapshot shows up in the Media folder.
1789 It is saved by default in \texttt{/tmp} as
1791 \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.
1793 Grabshot is the $6^{th}$ menu item.
1794 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.
1799 \section{Other Options and Other Windows}%
1800 \label{sec:other_options_and_other_windows}
1802 \subsection{Transport Controls}%
1803 \label{sub:transport_controls}
1805 Transport controls are useful for navigation and for playing media.
1806 Each of the Viewer, Compositor, and Program windows has its own transport panel.
1807 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.
1809 The transport panel is controlled by the keyboard as well as the graphical interface.
1810 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.
1811 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.
1813 The orientation of the end or start depends on the direction of playback.
1814 If it is forward the end position is the end of the selected region.
1815 If it is backward the end position is the start of the selected region.
1816 The insertion point moves to track playback.
1817 When playback stops, the insertion point stays where playback stopped.
1818 Thus, by playing back you change the position of the insertion point.
1819 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).
1820 Hitting any key on the keyboard twice pauses it.
1821 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.
1823 When using frame advance functions the behavior may seem odd.
1824 If you frame advance forward and then frame advance backward, the displayed frame does not change.
1825 This is because the playback position is not the frame but the time between two frames.
1826 The rendered frame is the area that the playback position crosses.
1827 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.
1828 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.
1830 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.
1832 The transport behavior also changes if you hold down the Shift key along with KeyPad 1--6.
1833 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.
1836 \subsection{Zoombar}%
1839 The compositor has zoom capability.
1840 The pull-down menu on the bottom of the compositor window has a number of zoom options.
1841 When set to Auto the video is zoomed to match the compositor window size as closely as possible.
1842 When set to any other percentage, the video is zoomed a power of 2 and scrollbars can be used to scroll around the output.
1843 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.
1845 The zoom toggle also causes the Compositor window to enter zoom mode.
1846 In zoom mode, clicking in the video output zooms in while a Ctrl-click in the video output zooms out.
1847 If you have a wheel mouse, rotating the wheel zooms in or out too.
1848 Zooming in or out with the zoom tool does not change the rendered output.
1849 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.
1850 This could affect performance on slower systems
1852 \subsection{Show Overlays}%
1853 \label{sub:show_overlays}
1855 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.
1856 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.
1857 The \textit{Color Coded Keyframe Curves} have distinct colors associated with each type for ease of identification.
1858 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.
1859 The color ball changes made will be retained across sessions.
1861 There is a line separating the first 4 items, which are just non-automation type settable values as opposed to \textit{auto} keyframe types.
1862 The color is not changeable for the 3 items of Mode, Pan, and Mask which simply display their symbol icon.
1864 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.
1865 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.
1867 \begin{figure}[htpb]
1869 \includegraphics[width=0.99\linewidth]{images/overlays_window.png}
1870 \caption{Show Overlays window on the left with the Color ball window to the right to set color}
1871 \label{fig:overlays_window}
1874 Screenshot below shows several color coded lines for different keyframes along with the Fade slider for manipulation.
1875 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.
1877 \begin{figure}[htpb]
1879 \includegraphics[width=0.8\linewidth]{images/overlays1.png}
1880 \caption{Lines are colored here on the timeline as designated in Show Overlays}
1881 \label{fig:overlays1}
1884 Overlays Window Nuances:
1886 The Overlays window is an alternative to the main track canvas View pulldown, and thus the order is mostly maintained to match each other.
1887 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.
1888 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.
1891 \item Shift+LMB (left mouse button) in the Overlays Window on a checkbox will turn off all other
1892 checkboxes except for the one you are on. Then this named box will have outline for a \textit{hot} spot.
1893 \item Shift+LMB on this \textit{hot} spot will return to \textit{cool} of the previous settings with all of the previous
1894 checkboxes checked again.
1895 \item Shift+LMB on a non-\textit{hot} spot will simply check or uncheck a box and there is no previous state.
1896 \item This all works in conjunction with the View pulldown menu which, of course, has no hot spots.
1897 \item Caveat \#1 - Shift+LMB on the top 4 choices of Assets, Titles, Transitions, Plugin Keyframes will turn
1898 off all of the checkboxes below because it makes sense to do so.
1899 \item Caveat \#2 - Shift+LMB on the Autos will not turn off Assets, Titles, Transitions, or Plugin Keyframes
1900 because you need to be able to see what is going on.
1901 \item Caveat \#3 - XYZ toggle on/off of Camera and Projector are not affected.
1904 \begin{figure}[htpb]
1905 \begin{minipage}{.29\linewidth}
1907 \includegraphics[width=0.99\linewidth]{images/overlays_list1.png}
1908 \caption{Original Settings --- cool spot}
1909 \label{fig:overlays_list1}
1912 \begin{minipage}{.29\linewidth}
1914 \includegraphics[width=0.99\linewidth]{images/overlays_list2.png}
1915 \caption{Note Titles box hot spot }
1916 \label{fig:overlays_list2}
1919 \begin{minipage}{.29\linewidth}
1921 \includegraphics[width=0.99\linewidth]{images/overlays_list3.png}
1922 \caption{Cam/Proj XYZ toggle to fine tune}
1923 \label{fig:overlays_list3}
1928 \subsection{Sound Level Meters Window}%
1929 \label{sub:sound_level_meters_window}
1931 An additional window, the levels window, can be brought up from the Window pulldown.
1932 The levels window displays the output audio levels after all mixing is done.
1933 The visible range of the sound level meters is configurable in \texttt{Settings $\rightarrow$ Preferences, Interface tab} under the Operations section.
1935 \begin{wrapfigure}[16]{O}{0.3\linewidth}
1938 \includegraphics[width=0.5\linewidth]{images/volume_meter.png}
1939 \caption{Sound Level Meters Window}
1940 \label{fig:volume_meter}
1943 Sound level meters can be toggled in the viewer and compositor windows with the show meters button.
1944 They also appear in the patchbay when the track is expanded and in the recording monitor when audio is being recorded.
1946 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.
1947 In the record monitor they are the input values from the sound card.
1948 In the patchbay they are the sound levels for each track after all effects are processed and before down-mixing for the output.
1949 Most of the time, audio levels have numerical markings in dB but in the patchbay there is not enough room.
1953 The sound level is color coded as an extra means of determining the sound level.
1954 Even without numerical markings, the sound level color can distinguish between several ranges and overload.
1955 Look at the color codings in a meter with numerical markings to see what colors correspond to what sound level.
1956 Then for meters in the patchbay in expanded audio tracks, use the color codings to see if it is overloading.
1958 Be aware that sound levels in Cinelerra can go above 0 dB.
1959 This allows for not only seeing if a track is overloading but how much information is being lost by the overloading.
1960 Overloading by less than 3 dB is usually acceptable.
1961 While overloading is treated as positive numbers in Cinelerra, it is clipped to 0 when sent to a sound card or file.