0a79e27b8b595c8942df2003a3a3a68d1d0ca025
[goodguy/cin-manual-latex.git] / parts / Plugins.tex
1 \chapter{Plugins}%
2 \label{cha:plugins}
3
4 There are realtime effects --- these are the most useful and probably all you will ever need --- and rendered effects. 
5 The rendered effects are discussed separately in the \nameref{sec:rendered_effects}  section. 
6 Effect plugins modify the track when played, according to how they are set, with no permanent storage of the output except when the project is rendered. There are many Plugins in Cinelerra-GG Infinity which are actually quite easy to use just by experimenting with them. The plugins are shown and selected from the \textit{Resources window} (figure~\ref{fig:video-plugins}). They are described in more detail later.
7
8 \begin{figure}[htpb]
9     \centering
10     \includegraphics[width=1.0\linewidth]{images/video-plugins.png}
11     \caption{Screencast of the native Video plugins in the default Cinfinity icon set.}
12     \label{fig:video-plugins}
13 \end{figure}
14
15 There is a choice of plugin icons which can be displayed.
16
17 In \texttt{Settings$\rightarrow$ Preferences$\rightarrow$ Appearance} tab, there is a pulldown for \textit{Plugin icons} where the user can choose between the \textit{original} icons, \textit{regular} or \textit{smoother}, \textit{cinfinity}\protect\footnote{Cinfinity /2 icon set is credited to Sam - Creative Common By --- \url{https://creativhecommons.org/licenses/by/3.0/}} --- the default modernized set, or \textit{cinfinity2} (figure~\ref{fig:audio-plugins}).
18
19 Note that when you change the plugin icons, your session will automatically save the backup, stop, restart, and reload (figure~\ref{fig:plugin-icons}).
20
21 \begin{figure}[htpb]
22     \centering
23     \includegraphics[width=0.7\linewidth]{images/audio-plugins.png}
24     \caption{Cinfinity2 audio plugins}
25     \label{fig:audio-plugins}
26 \end{figure}
27
28 \begin{figure}[htpb]
29     \centering    
30     \begin{tikzpicture}[scale=1, transform shape]
31     \node (img1) [yshift=0cm, xshift=0cm, rotate=0] {\includegraphics[width=0.6\linewidth]{images/plugin-icons.png}};
32     \node [yshift=-10mm, xshift=-1cm,anchor=east] at (img1.north west) (Preferences) {Preferences Window};
33     \node [yshift=-20mm, xshift=-1cm,anchor=east] at (img1.north west) (Tab) {Tab section};
34     \node [yshift=-51mm, xshift=-1cm,anchor=east] at (img1.north west) (Icon) {Plugin icon choices};    
35     \draw [->, line width=1mm] (Preferences) edge  ([yshift=-10mm] img1.north west);
36     \draw [->, line width=1mm] (Tab) edge  ([yshift=-20mm] img1.north west);
37     \draw [->, line width=1mm] (Icon) edge    ([yshift=-51mm] img1.north west);   
38     \end{tikzpicture}    
39     \caption{Screencast showing the screen to change your plugin icons set}
40     \label{fig:plugin-icons}
41 \end{figure}
42
43 \section{How to Use Plugins}%
44 \label{sec:how_use_plugins}
45
46 \textit{Realtime} effect plugins are listed in the Resources window as \textit{Audio} Effects and \textit{Video} Effects. Effect plugins are used by dragging them from the Resources window onto an audio track if it is an audio effect or video track if it is a video effect. You will see a colored bar appear beneath the track with the plugin name on it. If there is data on the destination track, the effect is applied to the entire track, unless a region of the track is selected in which case the effect is pasted into that region only. If there is no data on the track the effect is not added.
47
48 Plugins are layered under the track they apply to. When dragging more than one effect onto a track, you will see the effects layering from \textit{top to bottom}, on the bottom of that track. When the track is played back, effects are processed from \textit{top to bottom}. The output of the top effect becomes the input of the bottom effect and so on.
49
50 Instead of dragging from the Resources window, effects may be applied to a track via a popup menu. Right click on a track and select \texttt{Attach effect} from the popup. The attach effect dialog gives you more capability than just dragging and dropping. For example, the attach effect dialog lets you attach two more types of effects: \textit{shared effects} and \textit{shared tracks} which are explained in a later section. Select a plugin from the Plugins column and hit the green colored checkmark under the plugins column to attach it. The result is the same as if the effect was dragged from the Resources window.
51
52 After attaching an effect to a track, it often needs to be configured. There are two ways to get to the configuration controls. Click on the magnifying glass symbol on the right side of the effect bar - this is the middle symbol on the bar as you can see in the picture below. Alternatively, you can right click on the effect bar to bring up the effect popup which has a Show option. Either method causes the GUI for the effect to appear in a separate window. There will not be a popup if the plugin has no GUI.
53
54
55 Besides the magnifying glass, for Show Controls, on the effect colored bar beneath the track, there are two more symbols.
56
57 \begin{wrapfigure}[2]{r}{0.3\linewidth}
58     \vspace{-3ex}
59     \centering
60     \includegraphics[width=0.7\linewidth]{images/button-options.png} 
61 \end{wrapfigure}
62
63 The rightmost knob is used to \texttt{Turn Off/Turn On} the effect where the default is On. This is useful to easily see that the plugin is doing what you expect. The leftmost symbol that looks like a gear is for \textit{Preset Edit} and its usage is described in the section \nameref{sec:saved_plugin_preset}.
64
65 \section{Editing Effects}%
66 \label{sec:editing_effects}
67
68 Many operations exist for manipulating effects once they are on the timeline. Because mixing effects and media is quite complex, the methods used in editing effects are not as concise as cutting and pasting. Some of the editing happens by dragging in/out points, some of the editing happens through popup menus, and some of it happens by dragging effects.
69
70 When enabled, which is the default, and you edit tracks, the effects follow the editing decisions. If you cut from a track, the effect shrinks. If you drag edit in/out points, the effect changes length. This behavior can be disabled by selecting \texttt{Settings$\rightarrow$ Preferences$\rightarrow$ Interface tab$\rightarrow$ Editing section} (figure~\ref{fig:editing-effects}).
71
72 \begin{figure}[htpb]
73     \centering
74     \includegraphics[width=0.8\linewidth]{images/editing-effects.png}
75     \caption{Screencast of the native Video plugins in the default Cinfinity icon set.}
76     \label{fig:editing-effects}
77 \end{figure}
78
79 To edit effects, you can move the timeline cursor over the effect borders until it changes to a resize left or resize right icon. In this state, if you drag the end of the effect, it performs an edit just like dragging an edit edge. The five editing behaviors of track trimming apply to effect trimming and they are bound to the mouse buttons that you set in interface preferences as shown in the previous screencast. \textit{Trimming} simply means changes the duration.
80
81 When you perform a trim edit on an effect, the effect boundary is moved by dragging it. Unlike track editing, the effect has no source length. You can extend the end of an effect as much as you want. Also unlike track editing, the starting position of the drag operation does not bind the edit decision to media. The media the effect is bound to does not follow effect edits. Other effects, however, do follow editing decisions made on an effect. You can disable effects from being subject to the edit decisions by using the pulldown Settings and toggling off Edit effects. If you drag the end of an effect which is lined up to effects on other tracks, the effects on the other tracks will be edited while the media stays the same. When you drag an effect in from the Resources window you can insert the effect in the portion of the row unoccupied by the trimming operation. In some cases you will want a trimming operation to change only one row of effects. This can be achieved by first positioning the insertion point on the start or end of the effect. Then press the \texttt{shift key} while beginning the trimming operation. This causes the operation to change only one row of effects.
82
83 You can move effects \textit{up} or \textit{down}. Every track can have a stack of effects under it. By moving an effect up or down you change the order in which effects are processed in the stack. Go to an effect and right click to bring up the effect menu. The \texttt{Move up} and \texttt{Move down} options move the effect up or down. When you are moving effects up or down, be aware that if they are shared as shared effects, any references will be pointing to a different effect after the move operation.
84
85 Finally, there is dragging of effects. Dragging effects works just like dragging edits. You must select the arrow in the main window transport buttons line to enter drag and drop mode before dragging effects. Dragging a plugin causes a highlight outline to be drawn over a targetable timeline region, and the plugin can be re-positioned into any plugin track.  The effects snap to media boundaries, effect boundaries, and tracks. If you drag a reference to a shared effect, the reference may point to the wrong effect afterwards.  It is recommended that you re-construct shared effect track references.
86
87 Figure~\ref{fig:drag-effect} showing 5 plugins, two still plugin, two have already been dragged and the \textit{Color 3 Way} in the process of being dragged. Note the gold-colored arrow which enables allow \textit{drag and drop} editing mode.
88
89 \begin{figure}[htpb]
90     \centering
91     \includegraphics[width=0.7\linewidth]{images/drag-effect.png}
92     \caption{Dragging the Color 3 way effect}
93     \label{fig:drag-effect}
94 \end{figure}
95
96 \section{Shared Effects and Shared Tracks}%
97 \label{sec:shared_effect_tracks}
98
99 Two other effect types available in the Attach Effect dialog are \textit{Shared effects} and \textit{Shared tracks}. In the case of a shared effect, the following conditions must be true:
100
101 \begin{itemize}[noitemsep]
102     \item There must be other effects in the timeline.
103     \item The other effects must be of the same type as the track you are attaching an effect to. That is for audio tracks, effect must be audio and for video tracks, effect must be a video effect.
104     \item The insertion point or selected region must start inside the other effects.
105 \end{itemize}
106
107 In the case of a shared track, there must be another track on the timeline of the same type as the track you are applying an effect to. If you right clicked on a video track to attach an effect, there will not be anything in the shared tracks column if no other video track exists. The same applies equally to audio tracks in that another audio track must exist. Shared tracks are often used as layers for titles, curves and keyframes.
108
109 If shared effects or shared tracks are available, they appear in the shared effects and shared tracks columns when you used the \textit{Attach effect} option (\texttt{RMB} on a track). When the green colored checkmark is clicked \texttt{OK}, anything highlighted in the column is attached under the current track.
110
111 Shared effects and shared tracks allow very unique things to be done. In the case of a shared effect, the shared effect is treated like a copy of the original effect, except that in the shared effect the GUI can not be brought up. All configuration of the shared effect is determined by the GUI of the original effect and only the GUI of the original effect can be brought up.
112
113 When a shared effect is played back, it is processed just like a normal effect except the configuration is copied from the original effect. Some effects detect when they are being shared. These effects determine what tracks are sharing them and either mix the two tracks together or use one track to stage some value. 
114
115 When an original track has a shared track as one of its effects, the shared track itself is used as a \textit{realtime} effect. This is more commonly known as \textit{bouncing tracks} but Cinelerra achieves the same operation by attaching shared tracks. The fade and any effects in the shared track are applied to the original track. Once the shared track has processed the data, the original track performs any effects which come below the shared track and then composites it on the output.
116
117 In order to prevent the shared track from mixing the same data as the original track on the output, enable the output \texttt{mute} toggle in the patchbay next to each track for which you do not want to mix on the output. If you are making a video and you do want the shared track to composite the original track's data on the output a second time, the video from the shared track would always appear under the video from the original track, regardless of whether it was on top of the original track. This is because shared tracks are composited in order of their attachment. Since it is part of the original track it has to be composited before the original track is.
118
119 \section{Saved Plugin Presets}%
120 \label{sec:saved_plugin_preset}
121
122 \textit{Presets} and \textit{Factory Presets} for Plugin settings are now combined with the Preset Keyframe Parameters allowing you to choose, apply, delete, and edit your own Presets which can then be easily saved in the file \texttt{\$HOME/.bcast5/Cinelerra\_presets}. In addition to your own saved presets, there are automatically available Factory presets for some plugins, for example the Lens video plugin. The Factory presets are preceded by an asterisk (*) and can not be modified permanently.
123
124 \begin{wrapfigure}[3]{r}{0.3\linewidth}
125     \vspace{-4ex}
126     \centering
127     \includegraphics[width=0.7\linewidth]{images/preset.png} 
128 \end{wrapfigure}
129 Note that using this is directly changing a keyframe object so you will only want to modify parameters you are familiar with. Most of the data is obvious and safe to change.
130
131 A Presets button on the plugin bar to the left of the Controls and On/Off button allows for quick access to this feature. The symbol resembles a gear (figure~\ref{fig:preset02}).
132     %\todo{I can't to remedy}%
133
134 \begin{figure}[htpb]
135     \centering    
136     \begin{tikzpicture}[scale=1, transform shape]
137     \node (img1) [yshift=0cm, xshift=0cm, rotate=0] {\includegraphics[width=0.6\linewidth]{images/preset02.png}};
138     \node [yshift=-20mm, xshift=-1cm,anchor=east] at (img1.north west) (Green) {A user preset Green};
139     \node [yshift=-101mm, xshift=-1cm,anchor=south east,text width=10em, inner ysep=-3mm] at (img1.north west) (Textbox) {Textbox to type in the title for the chosen preset or name for a new preset.};
140     \node [yshift=-110mm, xshift=-1cm,anchor=north east,text width=10em,inner ysep=-3mm] at (img1.north west) (Save) {Use the Delete, Save or Apply button for operation.};    
141     \draw [->, line width=1mm] (Green) edge  ([yshift=-20mm] img1.north west);
142     \draw [->, line width=1mm] (Textbox.south east) --  ([yshift=-101mm] img1.north west);
143     \draw [->, line width=1mm] (Save.north east) --    ([yshift=-110mm] img1.north west);   
144     \end{tikzpicture}    
145     \caption{Screencast shows 4 Factory presets as preceded by an *.}
146     \label{fig:preset02}
147 \end{figure}
148
149 \section{Some specific details concerning Plugins}%
150 \label{sec:specific_details_plugins}
151
152 These next few sections explain some details about the plugins that are not directly related to actually using them but help to work with them.
153
154 \subsection{How to see short Description of a Plugin}%
155 \label{sub:short_description_plugin}
156
157 To get a short one or a few lines description of a plugin, right click on that plugin in the Resources window and when the popup menu appears, select \texttt{Info}. Some of the plugins may not have any description included. An example screenshot is next (figure~\ref{fig:info-effect}).
158
159 \begin{figure}[htpb]
160     \centering
161     \includegraphics[width=0.7\linewidth]{images/info-effect.png}
162     \caption{Effect Info for Color 3 Way}
163     \label{fig:info-effect}
164 \end{figure}
165
166 \subsection{Delete Plugins to save Resources Space or make them Unavailable}%
167 \label{sub:delete_plugin_resouces_unavaible}
168
169 Maybe you just don't ever use certain plugins or would prefer to only find the ones that are useful to you. To save space in the Resources Window so you don't have to scroll to find the plugins you want as much, a feature to delete others is available. If you have a System install, you will have to be root for this function to be usable. The plugins will be permanently deleted, but only until you rebuild or download a new set of Cinelerra binaries. To delete a plugin, highlight the plugin you no longer want in the Resources window then press \texttt{Ctrl-Shift-delete}. A small window will come up allowing you to change your mind and red-X out or check-OK to remove plugin. This feature may come in handy if you have personnel working on media for you and you only want them to exercise certain functions. Or maybe you can't remember which is the good \textit{deinterlace} plugin out of the available five or so and want to delete the extras so as not to be confused. The ffmpeg, \textit{ladspa}, and \textit{lv2} plugins can not be deleted in this manner but, of course, you can always turn them off from view by clicking on \textit{Visibility} and unchecking them (figure~\ref{fig:remove-effect}).
170
171 \begin{figure}[htpb]
172     \centering
173     \includegraphics[width=0.7\linewidth]{images/remove-effect.png}
174     \caption{Remove Deinterlace-CV plugin}
175     \label{fig:remove-effect}
176 \end{figure}
177
178 \subsection{Updatable Icon Image Support}%
179 \label{sub:updatable_icon_image_support}
180
181 When running Cinelerra-GG Infinity builtin icons are loaded before the program starts. Png files in the path: \\ \texttt{<target\_directory>picon/picon\_set\_name} \\
182 are searched before the images loaded into memory. Override \texttt{icon.png} files must be put into the path: \\ \texttt{<target\_directory>/picon/picon\_set\_name} \\
183 There are currently 4 sets of icons and their directory names are \textit{cinfinity} (the default) and \textit{cinfinity2}, \textit{original} (the long-time original set), and \textit{smoother} (generally was in use by some of the themes). An example, to replace the cinfinity icon of Blue Banana with a red apple instead, create your \texttt{.png} file as desired, and replace the file in: \\ \texttt{<target\_directory>/bin/plugins/picon/cinfinity/bluebanana.png}.
184
185 For most User installs, the \texttt{<plugin\_name>.png} file will be located at:
186
187 \texttt{<cinlib\_path>/bin/plugins/picon/cinfinity} (or cinfinity2, original or smoother)
188
189 For some System installs, the files might be located at:
190
191 \texttt{/usr/lib/cin/plugins/picon/cinfinity} (or cinfinity2, original or smoother) (ubuntu distros)
192
193 \texttt{/usr/lib64/cin/plugins/picon/cinfinity} (or cinfinity2, original or smoother) (Leap distro)
194
195 \subsection{Details on where to put your own Plugin Icons}%
196 \label{sub:details_put_plugin_icons}
197
198 In order to make the icons available to all themes, which would thus be the default when no theme-specific icon is available, put the png file in the:
199
200 \texttt{<cinlib\_path>/bin/plugins/picon/cinfinity} (or cinfinity2, original or smoother)
201
202 The Cinelerra program looks for a plugin icon in two places:
203
204 \begin{enumerate}
205     \item First, it tries to find a png file in \texttt{<cinlib>/plugins/picon/cinfinity}(2) or original, smoother directory.
206     \item If there is no corresponding \texttt{.png} file for a plugin, the program uses a built-in default:
207     \begin{itemize}
208         \item ordinary video plugins use 3 vertical color bars as a default;
209         \item ffmpeg plugins use the words \textit{FF} on yellow colored background as a default icon;        
210         \item audio and ladspa plugins use a green-colored audio wave for a default.              
211     \end{itemize}
212 \end{enumerate}
213 \begin{figure}[htpb]          
214     \centering
215     \includegraphics[width=0.05\linewidth]{images/audio-default.png} 
216 \end{figure} 
217
218 Keep in mind these points for newly created plugin icons:
219
220 \begin{itemize}
221     \item All included icon images become part of open source, in the public domain, and not proprietary.
222     \item The preferred format is $52 x 52$, $8\,bit$ /color RGB or RGBA, non-interlaced.
223     \item Since plugin icons are used by different themes, it is recommended that a \textit{transparent background} be used. Otherwise some color background that looks good for one theme may not for another.
224     \item In order to test a new icon, you have to have write permission in the: \\ 
225     \texttt{<cinlib\_path>/plugins} directory so you may have to become the root user to copy the .png file to the correct location.
226     \item If there is currently no theme-specific \texttt{.png} files present, it may be necessary to first create the theme directory in \texttt{<cinlib\_path>plugins} as \texttt{<theme\_name>} in order to put the \texttt{.png} files in that subdirectory.
227     \item Make sure that the \textit{ownership} and file \textit{permissions} match the existing directory and files.
228     \item All ffmpeg icons must begin with \texttt{ff\_<plugin\_name>.png} (Resources window title will still be \texttt{F\_\dots})
229     \item For ladspa, check in the \texttt{<cin\_config>} directory (\texttt{\$HOME/.bcast5} normally) and look for the text file \texttt{\$HOME/.bcast5/ladspa\_plugins\dots} for the names of the ladspa libraries which correspond to plugin names where the needed name is the basename of the \texttt{.so} file. For example \texttt{phasers\_1217.so} would need to have a \texttt{phasers\_1217.png} file. There may be multiple plugins in a single “so” file which means that you can only have 1 icon to represent all of the plugins in that file; again as in phasers.
230     \item Once you have placed the .png file in the correct spot, you will have to restart Cinelerra to test it.
231     \item To submit your .png file for inclusion into Cinelerra-GG Infinity for all to enjoy, it is best to upload it to any datafilehost and notify the community via email with any informative documentation.
232 \end{itemize}
233
234 \subsection{Example of new Plugin Icon Testing}%
235 \label{sub:example_plugin_icon_testing}
236
237 For a simple test just copy an existing \texttt{<plugin\_name>.png} file into the cinfinity directory with the name \texttt{bluebanana.png} to write over the existing file. This icon will now show up in cinelerra and still execute the Blue Banana function.
238
239 For an ffmpeg plugin, create \texttt{ff\_loop.png} and copy it to: \\
240 \texttt{<cinlib\_path>/plugins/picon/original}. This icon will show up in cinelerra if original is selected and execute the \texttt{F\_loop} function.
241
242 For a ladspa plugin, the text line in \$HOME/.bcast5/ladspa\_plugins… as seen below:
243 2 \texttt{am\_pitchshift\_1433.so} \\
244 \texttt{AM pitchshifter} $1504922321\, 0\, 1\, 0\, 0\, 1\, 0\, 1\, 0\, 1\, 0\, 0$ indicates that you would create the icon: \\ \texttt{<cinlib\_path>/plugins/picon/cinfinity/am\_pitchshift\_1433.png} \\
245 For your own personal plugins, you can create a directory on your system and put any plugin png files you like into that directory. For example, if you want a specialized picon for \texttt{F\_aeval}, create a picon named \texttt{ff\_aeval.png} in: \\ \texttt{<cinlib\_path>/plugins/picon/yournamehere.}
246
247 \begin{lstlisting}[language=Bash]
248 cd <cinlib>/plugins            # go to the correct directory
249 mkdir -p picon/yournamehere    # create subdirectory if does not exist
250 ls -l picon/*                  # list the picon directories
251                                # check for existence (and permissions)
252 cp yourpicon.png ff\_aeval.png # Copy your example .png file
253 \end{lstlisting}
254
255 Restart cin by changing \texttt{Settings$\rightarrow$ Preferences$\rightarrow$ Appearance} and in \textit{Plugins icons} choose a directory.
256
257 \subsection{Plugins/Effects Visibility}%
258 \label{sub:plugins_effects_visibility}
259
260 Cinelerra contains many plugins, especially with the addition of ffmpeg, and it is somewhat difficult to find the one you are looking for in the Resources window. In Cinelerra-GG Infinity, the plugins have been categorized into the following subsets in the Visibility section of the Resources window to make it easier to locate a particular one:
261
262 \textit{Audio Effects, \quad Video Effects, \quad Audio Transitions, \quad Video Transitions}
263
264 \begin{figure}[htpb]
265     \centering
266     \includegraphics[width=0.8\linewidth]{images/visibility01.png}
267     \caption{Screenshot showing on the left hand side the Visibility box with Audio Effects highlighted.}
268     \label{fig:visibility01}
269 \end{figure}
270
271 The Visibility tool in the Resources window (figure~\ref{fig:visibility01}) gives you the ability to turn off or on any of several sets of plugins. If you left-click the Visibility box, you will see the various categories of plugins, such as \textit{ladspa}, \textit{ffmpeg}, \textit{audio}, \textit{lv2}, and \textit{video} (figure~\ref{fig:visibility02}).
272
273 Highlight the set you want to turn on and a check mark appears to show it is active. Highlight again to toggle it off. See the next screenshot which illustrates that all of the plugins are turned off (not visible) except for audio. There is also the ability to add your own personal directory of plugins which will show up here. All you have to do to have these plugins become visible is to create a directory, with some name that is meaningful to you, and put your \texttt{.png} files in your: \\
274 \texttt{cinelerra\_path bin/plugins/<your\_directory\_name>}.
275
276 \begin{figure}[htpb]
277     \centering
278     \includegraphics[width=0.7\linewidth]{images/visibility02.png}
279     \caption{Screenshot showing the Visibility categories of plugins with all toggled on and audio highlighted.}
280     \label{fig:visibility02}
281 \end{figure}
282
283 \subsection{Expanders for Plugin Subtrees in the Resources Window}%
284 \label{sub:expanders_plugin_subtrees}
285
286 To accentuate a set of common plugins, there are \textit{expander} arrows on the left side of the Resources window. You will see these expanders only when in \textit{Display text} mode, not \textit{icon} mode. Cinelerra’s default setup is in the file \texttt{\$CIN\_DAT/expanders.txt} but if the user wants their own specific setup and if the file in \texttt{\$HOME/.bcast5/expanders.txt} exists, it will take precedence. If there are recommendations for other relevant categories, they can be added. The subtree structure is applicable to any of the \textit{Video Effects/Transitions} or \textit{Audio Effects/Transitions}. You can not sort once an expansion is in effect (figure~\ref{fig:expander}).
287
288 The \texttt{expanders.txt} file has very specific requirements. The most specific is that there are no blanks --- you must use tabs only. A \# (pound sign) can be used in column 1 to indicate a comment. Here is a short example:
289
290 \begin{lstlisting}[language=Bash]
291 Video Effects
292     - Color_Correction
293         Blue Banana
294 #\qquad \qquad Color 3 Way
295         Color Balance
296 Audio Effects
297     - Calf
298     - Instruments / Generators
299         L2_Calf Organ
300         L2_Calf Monosynth
301         L2_Calf Fluidsynth
302 \end{lstlisting}
303
304 \begin{figure}[htpb]
305     \centering
306     \includegraphics[width=0.8\linewidth]{images/expander.png}
307     \caption{$\bigtriangledown$, $\rhd$ =expander; "-" = options}
308     \label{fig:expander}
309 \end{figure}
310
311 \subsection{Speed-up of Ffmpeg plugin usage with OPTS files}%
312 \label{sub:speedup_ffmpeg_plugin_opts}
313
314 You can speed up some ffmpeg plugins that are quite time-consuming and use a lot of CPU. For a specific color-based example, Cinelerra uses 6 primary rendering color models. All of them have 3 components at full scale. Direct usage of a particular ffmpeg plugin from the ffmpeg command line might handle the planar at less than full scale chroma (yuv420), which means there is less data to manipulate. But when cinelerra loads a video it uses full scale color models. In other words:
315
316 \begin{itemize}[noitemsep]
317     \item cinelerra uses \textit{yuv444}
318     \item ffmpeg uses \textit{yuv420}
319 \end{itemize}
320
321 if using an ffmpeg plugin that uses filters and many passes over the data, the amount of data is a big factor. If you load a file in cinelerra with a
322
323 \texttt{same\_directory\_path\_and\_filename.opts}
324
325 file containing the following line, the full scale color modeling upgrade will not be performed until after any plugin, and then the render is faster:
326
327 \begin{lstlisting}[language=Bash]
328 video_filter=xxxxxx=threads=8 # where xxxxxx is the desired filter
329 \end{lstlisting}
330
331 When the file loads, however, it will initially take longer because it is running through the video filter. The format \textit{rgb} in ffmpeg uses more cpu time. For comparison, ffmpeg line that might be used:
332
333 \begin{lstlisting}[language=Bash]
334 ffmpeg -i /tmp/filename.mpeg -threads 15 -vf format=rgb24,xxxxxxs=threads=8 -acodec ac3 -vcodec libx265 - y /tmp/x.mp4
335 \end{lstlisting}
336
337 This converts the input to \textit{rgb} before xxxxxx runs, and so it too is slower (because there is more color data). You would ordinarily avoid this conversion by omitting the \texttt{format=rgb24} parameter. An example ffmpeg plugin that could easily take advantage of an auxilliary opts file is \textit{nlmeans}.
338
339 \section{Audio Effects - Native}%
340 \label{sec:audio_effects_native}
341
342 \subsection{AudioScope}%
343 \label{sub:audioscope}
344
345 Convert input audio to video output representing the audio power spectrum. Shows
346 % Yes
347  %\todo{It's OK to use Subsection every plugin?}%
348 you the sound wave.
349
350 \subsection{Compressor}%
351 \label{sub:compressor}
352
353 The audio compressor reduces the dynamic range of the audio, not the amount of data required to store the audio. In Cinelerra the compressor actually performs the function of an expander and compressor. 
354
355 The compressor works by calculating the maximum sound level within a certain time period of the current position. The maximum sound level is taken as the input sound level. For every input sound level there is an output sound level specified by the user. The gain at the current position is adjusted so the maximum sound level in the time range is the user specified value (figure~\ref{fig:compressor}).
356
357 \begin{figure}[htpb]
358     \centering
359     \includegraphics[width=0.7\linewidth]{images/compressor.png}
360     \caption{GUI of configuration for Compressor plugin}
361     \label{fig:compressor}
362 \end{figure}
363
364 The compressor has a graph which correlates every input sound level to an output level. The horizontal direction is the input sound level in dB. The vertical direction is the output sound level in dB. The user specifies output sound levels by creating points on the graph. Click in the graph to create a point. If two points exist, drag one point across another point to delete it. The most recent point selected has its values displayed in textboxes (\texttt{X}) for more precise adjustment.
365
366 To have the compressor reduce the dynamic range of the audio, make all the output values greater than the input values except $0$\,dB. To make the compressor expand the dynamic range of the audio, make all the output values except $0$\,dB less than the input values. The algorithm currently limits all sound levels above $0$\,dB to $0$\,dB, so to get an overloaded effect put a gain effect before the compressor to reduce all the levels and follow it with another gain effect to amplify all the levels back over $0$\,dB.
367
368 \begin{description}
369     \item[Reaction secs] this determines where in relation to the current position the maximum sound level is taken and how fast the \textit{gain} is adjusted to reach that \textit{peak}. It is in seconds. If the reaction time is negative the compressor reads ahead of the current position to get the future peak. The gain is ramped to that peak over one reaction time. This allows it to hit the desired output level exactly when the input peak occurs at the current position. If the reaction time is positive the compressor scans only the current position for the gain and ramps gain over one reaction time to hit the desired output level. It hits the output level exactly one reaction time after detecting the input peak.
370     \item[Decay secs] if the peak is higher than the current level, the compressor ramps the gain up to the peak value. Then if a future peak is less than the current peak it ramps the gain down. The time taken to ramp the gain down can be greater than the time taken to ramp the gain up. This ramping down time is the decay seconds.
371     \item[Trigger type] the compressor is a \textit{multi-channel effect}. Several tracks can share one compressor. How the signal from many tracks is interpreted is determined by the \textit{trigger type}. The Trigger type uses the value supplied in the Trigger textbox as the number of the track to use as input for the compressor. This allows a track which is not even heard to determine the loudness of the other tracks. The maximum trigger takes the loudest track and uses it as the input for the compressor. The Total trigger type adds the signals from all the tracks and uses the total as the input for the compressor. This is the most natural sounding compression and is ideal when multiple tracks are averaged into single speakers.
372     \item[Trigger] This parameter is used in conjunction with trigger type as described previously. Normally only one track is scanned for the input peak. This track is specified by the Trigger. By sharing several tracks and playing with the trigger value, you can make a sine wave on one track follow the amplitude of a drum on another track, for example.
373     \item[Smooth only] for visualizing what the compressor is doing to the \textit{sound-level}, this option causes it to replace the sound wave with just the current \textit{peak value}. It makes it very easy to see how \textit{reaction secs} affects the detected peak values.
374 \end{description}
375
376 \subsection{DC Offset}%
377 \label{sub:dc_offset}
378
379 Use this to remove \textit{DC Offset}, which is usually an undesirable characteristic of a recording normally caused by defective equipment. This effect works like a \textit{high pass filter} and has no controls. DC stands for Direct Current which is the average amplitude of the waveform. It sounds best when it is absent, represented by zero, so that there is no imbalance in the audio.
380
381 \subsection{Delay Audio}%
382 \label{sub:delay_audio}
383
384 In the Delay Audio effect you can specify the number of seconds you want to delay the video track.
385
386 \subsection{DeNoise}%
387 \label{sub:denoise}
388
389 Reduce audio background noise. There is only 1 parameter which is used to regulate the level dial with a range of 0 to 1.
390
391 \subsection{DenoiseFFT}%
392 \label{sub:denoisefft}
393
394 Noise removal from audio using FFT editing. Set the Denoise Power dial in dB and choose the number of reference samples.
395
396 \subsection{Despike}%
397 \label{sub:despike}
398
399 Detect and eliminate out of range impulse values.
400
401 \begin{description}
402     \item[Maximum level:] slider to set the maximum value in dB above which the frequency cutting takes place.
403     \item[Maximum rate of change:] to adjust peak delete in dB.
404 \end{description}
405
406 \subsection{EQ Graphic}%
407 \label{sub:eq_graphic}
408
409 Graphic equalizer sets the output levels for specified frequency bands. This effect works by setting control points when you click the left mouse button and drag to the desired value. In the textboxes at the bottom can be seen the frequency of the active control point, the level of the signal to be set by entering the numerical value or by dragging the control point, and the number of samples to act on (figure~\ref{fig:equalizer}).
410
411 \begin{figure}[htpb]
412     \centering
413     \includegraphics[width=0.8\linewidth]{images/equalizer.png}
414     \caption{Graphic Equalizer audio plugin}
415     \label{fig:equalizer}
416 \end{figure}
417
418 \subsection{EQ Parametric}%
419 \label{sub:eq_parametric}
420
421 Parametric equalizer shows and outputs levels for \textit{frequency}, \textit{quality}, \textit{level}, \textit{mode}, and \textit{wetness}.
422
423 \subsection{Echo}%
424 \label{sub:echo}
425
426 Echo is reflection of sound. This plugin could be used to add echoing to video of your canyon hike (figure~\ref{fig:echo}).
427
428 \begin{figure}[htpb]
429     \centering
430     \includegraphics[width=0.5\linewidth]{images/echo.png}
431     \caption{The 3 dials of Echo plugin}
432     \label{fig:echo}
433 \end{figure}
434
435 \begin{description}
436     \item[Level] represents the volume adjustment.
437     \item[Atten] is attenuation which is a general term that refers to any reduction in the echo reflection. Sometimes called loss, attenuation is a natural consequence of signal transmission over long distances.    
438     \item[Offset] is the lag in the attenuated echo signal. Offset means adding a DC level to a signal. It offsets the signal up or down in a DC sense without changing the size of the AC part of the signal. When you add an audio clip to the Timeline, the clip plays back from the beginning of the source audio file. The point in the audio file where the clip starts playing is called the offset. By default, a clip’s offset is zero, the beginning of the source audio file. You can change the offset so that the clip starts playing from a later point in the source audio file.
439 \end{description}
440
441 \subsection{EchoCancel}%
442 \label{sub:echocancel}
443
444 EchoCancel is the process of removing echos from audio in order to improve the quality. Echo cancel may be needed because an audio recording was done in a room that led to echo generation or there was some kind of unwanted feedback. There are many controls for the EchoCancel plugin which are defined here. However, the first thing you will see when you bring up the plugin, is the top portion that is black which will show a + in the middle when you mouse over it. Once you start playing audio, you will see the cepstrum spectral data inside the window. A cepstrum results from taking the inverse Fourier transform (IFT) of the logarithm of the estimated spectrum of a signal. It is used to identify the period of the echo in the audio. It is recommended to just set the Mode to On but the below defined parameters can be utilized by professionals (figure~\ref{fig:echo-cancel}).
445
446 \begin{figure}[htpb]
447     \centering
448     \includegraphics[width=0.8\linewidth]{images/echo-cancel.png}
449     \caption{GUI for EchoCancel with crosshair and mode set to ON}
450     \label{fig:echo-cancel}
451 \end{figure}
452
453 \begin{description}
454     \item[Normalize:] audio normalization adds variable amounts of gain to an audio recording to bring the average or peak amplitude to a target level (the normal amount), on an ongoing buffer by buffer basis. This is to make the cepstrum graphical data appear between 0 and 1. Checkmark appears if \texttt{ON}.
455     \item[Level:] scale factor used to draw the cepstrum output when normalize is not in effect.
456     \item[History:] number of previous cepstrum outputs redrawn as fading graphical data.
457     \item[X Zoom:] X axis scale factor to magnify low frequency cepstrum graphical output.
458     \item[Damp:] echo envelope decay factor used to smooth the cepstrum/correlation data.
459     \item[Peaks:] number of maximal envelope values used in the echo gain calculation.
460     \item[Cutoff Hz:] low frequency cutoff value to prevent beat frequency (\textit{heterodyne}) echo canceling.
461     \item[Mode:] \textit{MAN}, \textit{Off}, or \textit{On}. When Off is selected, the plugin is not active. When MAN is used, the only one peak is used for the echo gain envelope. It is set by pressing mouse button $1$ in the ceptstrum graphical output. The Gain and Offset are updated as the pointer drag operation resets the indicated gain and offset values. When On is selected, the echo gain envelope is automatically calculated by cepstrum and auto-correlation of the input audio in the last window size audio samples.
462     \item[Windows size:] parameter can be set to \textit{Default}, $1024$, $2048$, \dots \textit{doubled values\dots} up to $262144$.
463     \item[Amplitude:] the cepstrum value at the drag point during manual envelope selection.
464     \item[Gain:] echo gain setting determined by manual selection.
465     \item[Offset:] echo period setting determined by manual selection. The $Hz$ (frequency), $ms$ (millisecond duration), and sample offset (audio samples) as determined by manual selection.
466 \end{description}
467
468 \subsection{Freeverb}%
469 \label{sub:freeverb}
470
471 Adds effect of multiple decaying echoes to audio signals based on a specific algorithm. Common use of reverb is to simulate music played in a closed room.
472
473 \subsection{Gain}%
474 \label{sub:gain}
475
476 Add gain, input level, to increase/decrease loudness.
477
478 \subsection{Interpolate}%
479 \label{sub:interpolate}
480
481 Generate a smooth curve based on sound creating a certain softness. There are no controls.
482
483 \subsection{Invert Audio}%
484 \label{sub:invert_audio}
485
486 Reverses the numerical sign of the digital audio. There are no controls.
487
488 \subsection{Live Audio}%
489 \label{sub:live_audio}
490
491 The Live Audio effect reads audio directly from the sound card input. It replaces any audio on the track so it is normally applied to an empty track. To use Live Audio, highlight a horizontal region of an audio track or define \textit{in} and \textit{out points}. Then drop the Live Audio effect into it. Create extra tracks and attach shared copies of the first Live Audio effect to the other tracks to have extra channels recorded. Live Audio uses the sound driver selected in \texttt{Settings$\rightarrow$ Preferences$\rightarrow$ Playback$\rightarrow$ Audio Out for recording}, but unlike recording it uses the playback buffer size as the recording buffer size and it uses the project sample rate as the sampling rate. These settings are critical since some sound drivers can not record in the same sized buffer they play back in. 
492
493 Live audio has been most reliable when ALSA is the recording driver and the playback fragment size is $2048$. Drop other effects after Live Audio to process sound card input in realtime. With live audio there is no read-ahead, so effects like compressor will either delay if they have read-ahead enabled or playback will under-run. A potential problem is that sometimes the recording clock on the sound card is slightly slower than the playback clock. The recording eventually falls behind and playback sounds choppy. Live Audio does not work in reverse.
494
495 \subsection{Loop Audio}%
496 \label{sub:loop_audio}
497
498 Loop some number of samples of audio over and over.
499
500 \subsection{Overlay}%
501 \label{sub:overlay}
502
503 Overlay has parameter settings of top or bottom for the track and add or multiply for the operation.
504
505 \subsection{Pitch Shift}%
506 \label{sub:pitch_shift}
507
508 Like the time stretching methods, there are three pitch shifting methods: \textit{Pitch shift}, \textit{Resample}, and \textit{Asset info} dialog. Pitch shift is a realtime effect which can be dragged and dropped onto recordable audio tracks. Pitch shift uses a fast Fourier transform (FFT) to try to change the pitch without changing the duration, but this introduces windowing artifacts. Because the windowing artifacts are less obtrusive in audio which is obviously pitch shifted, Pitch Shift is mainly useful for extreme pitch changes. For mild pitch changes, use Resample instead. Another way to change pitch slightly is to go to the Resources window, highlight the media folder, right click on an audio file, click on \texttt{Info}, then adjust the sample rate in the Info dialog to adjust the pitch. This method also requires left clicking on the right boundary of the audio tracks and dragging left or right to correspond to the length changes.
509
510 \subsection{Remove Gaps}%
511 \label{sub:remove_gaps}
512
513 Remove silent gap (below $DB$ threshold) which persist for more than the time limit.
514
515 \subsection{ResampleRT}%
516 \label{sub:resamplert}
517
518 Allows you to convert an audio file from one sample rate to another. This effect works similarly to ReframeRT in videos.
519
520 \begin{center}
521     \begin{tabular}{l l}
522         \toprule
523         Input / output > 1 &    fast rate \\
524         Input / output < 1 &    slow rate \\        
525         \bottomrule
526     \end{tabular}
527 \end{center}
528
529 \subsection{Reverb}%
530 \label{sub:reverb}
531
532 Reflections of sound to add depth and fullness. Simulates creation of a large number of reflections (lots of walls) which build up and then decay. You can use the reverb plugin to mix tracks together to simulate ambiance.
533
534 \subsection{Reverse Audio}%
535 \label{sub:reverse_audio}
536
537 Apply reverse audio to an audio track and play it backwards. The sound plays forward. Be aware when reversing audio that the waveform on the timeline does not reflect the actual reversed output.
538
539 \subsection{SoundLevel}%
540 \label{sub:soundlevel}
541
542 Displays the Max/RMS sound level in decibels.
543
544 \subsection{Spectrogram}%
545 \label{sub:Spectrogram}
546
547 Visual representation of the sound levels at specified frequencies as they vary with time.
548
549 \subsection{Synthesizer}%
550 \label{sub:Synthesizer}
551
552 Generate synthesizer sounds; to set key data, turn on Generate keyframes while tweaking (figure~\ref{fig:synthesizer}).
553
554 \begin{figure}[htpb]
555     \centering
556     \includegraphics[width=0.7\linewidth]{images/synthesizer.png}
557     \caption{GUI for Synthesizer}
558     \label{fig:synthesizer}
559 \end{figure}
560
561 \subsection{Time Stretch RT}%
562 \label{sub:time_stretch_rt}
563
564 Change the speed of an audio signal without affecting its pitch.
565
566 \section{Audio Ladspa Effects}%
567 \label{sec:audio_ladspa_effects}
568
569 Ladspa effects are supported in realtime and rendered mode for audio. These audio effects are supported since Cinelerra implements the LADSPA interface as accurately as possible. Besides the supplied LADSPA effects\protect\footnote{credit Steve Harris}, additional LADSPA effects can be enabled by setting the \texttt{LADSPA\_PATH} environment variable to the location of your LADSPA plugins:
570
571 \begin{lstlisting}[language=Bash]
572 export LADSPA_PATH=/usr/lib/ladspa
573 \end{lstlisting}
574
575 \section[Audio LV2 / Calf Plugins]{Audio LV2 / Calf Plugins\protect\footnote{Optional Feature - OS dependent}}%
576 \label{sec:audio_lv2_calf_plugins}
577
578 LV2 is an open standard for audio plugins using a simple interface with extensions which add functionality to support audio software. These plugins were written by external developers and provide additional audio effects to Cinelerra audio without having to change Cinelerra every time. Because the LV2 plugins are separate from Cinelerra-GG Infinity, if one fails or does not perform as expected, cinelerra should stay running and you will have to contact the programmers responsible for that plugin for a fix.
579
580 Typically, a user OS has specialized package groups installed. It is difficult to create one build of cinelerra to accommodate all potential LV2 plugins. Specifically for the \textit{Calf-Studio LV2 plugins}, you should install the Calf Plugins package. The user’s computer must have \texttt{gtk-2-runtime} installed, which seems to be automatically done already for most distros. For users doing their own builds, you can build cinelerra without LV2 support by including \texttt{--without-lv2} in the configure step. The default build is \texttt{--with-lv2=yes} and requires that \texttt{GTK-2-devel} must be installed or the build will fail and notify you.
581
582 LV2 plugins have their own category in the \textit{Audio Plugins Visibility} as lv2. There is a simple text interface which is available via the usual \texttt{Show controls} button when the plugin is attached to the audio track. This window has a Reset button to get back to the default settings. To change a value of one of the parameters, highlight that parameter and type in the new value in the topmost text box and then hit \texttt{apply} to take effect --- the reason for requiring hitting apply is so that the audio is not moving all over the place while you are still typing a value. More easily, you can just move the \textit{pot dial} or the \textit{slider} bar which take effect automatically. 
583
584 Cinelerra’s buffer size setting may cause a delay in activation of the changes you make taking effect, so you can lessen the time by using a small buffer. Notice that $1024$ samples at $48000$ samples per sec is only $\frac{1}{50}^{th}$ a second. This is not a lot of time to shuffle a bunch of stuff. Short buffers produce low latency, but no time for complex programs or lots of stacked effects. Bigger buffers allow for more complex setups.
585
586 To set the buffer size:
587
588 \texttt{Settings$\rightarrow$Preferences$\rightarrow$ tab Playback A$\rightarrow$ section Audio Out $\rightarrow$ \\
589 variable Playback buffer samples}
590
591 However, be forewarned that due to variability in the lv2 plugin programming code, some of the plugins only work with the minimum buffer size of $1024$. In these cases, what you will see is the main track canvas cursor just bounces back and forth over a very small area in the timeline. This does not crash cinelerra but you will have to remove the plugin to continue working.
592 You can specify a certain set of LV2 plugins to use by setting \texttt{LV2\_PATH} as shown below before starting cinelerra --- include a colon ($:$) separator for multiple paths. The default path for most operating systems is \texttt{/usr/lib64/lv2}. To list the system installed lv2 plugins key in: \texttt{lv2ls}.
593
594 \begin{lstlisting}[language=Bash]
595 export LV2_PATH=/tmp/j/balance.lv2/usr/local/lib/lv2/:/usr/local/lv2
596 \end{lstlisting}
597
598 If there is no default \texttt{LV2\_PATH} set automatically, the value will be \texttt{\$CIN\_DAT/lv2}, which is a placeholder only so that no lv2 plugins will be loaded. When there is no system \texttt{LV2\_PATH} set it is important to note, that if you do want lv2 plugins loaded, you must set the correct path in:
599
600 \texttt{Settings$\rightarrow$Preferences$\rightarrow$Interface tab$\rightarrow$ Default LV2$\rightarrow$ directory \\
601     path name}
602
603 When you change this field, cin will automatically restart and load the newly specified lv2 plugins. If when switching \texttt{LV2\_PATH} or if the lv2 audio plugins are not displayed/usable in the Resources window, you can execute a reload via:
604
605 \texttt{Settings$\rightarrow$  Preferences$\rightarrow$ Interface tab$\rightarrow$ Reload plugin index} \\
606 or else before you bring up cinelerra, delete \texttt{\$HOME/.bcast5/Cinelerra\_plugins} so that the plugins get properly reloaded.
607
608 There are some lv2 plugins that display a \textit{glitzy} UI (User Interface); for example the \textit{Calf plugins}. For these LV2 plugins, if you want that to automatically come up without having to click on the UI button on the simplified UI interface, there is a flag to enable that. It is at:
609
610 \texttt{Settings$\rightarrow$ Preferences$\rightarrow$ Operations} tab
611
612 then check the \texttt{Auto start lv2 gui} Flag
613
614 Below is a screencast showing the auto start gui flag and the \texttt{LV2\_PATH} default directory path on the bottom line. Note the highlighted \texttt{Reload plugin index} which will be executed if OKed (figure~\ref{fig:reload}).
615
616 \begin{figure}[htpb]
617     \centering
618     \includegraphics[width=0.8\linewidth]{images/reload.png}
619     \caption{\textit{Reload plugin index} in yellow and \textit{Auto start lv2 gui} unchecked}
620     \label{fig:reload}
621 \end{figure}
622
623 There is also a blacklist that prevents known problematic-for-cinelerra lv2 plugins from loading to avoid crashes. If others are found to have problems, once informed about them, they will be added to this blacklist. In order to determine which lv2 plugin causes a SEGV on cinelerra startup, you can start from a terminal window and you will see each plugin that is being loaded and the last one shown before the crash is a bad plugin. However, many of the plugins causing a crash are due to not having been compiled on your current system with the current compiler so may actually work correctly on other user systems and so will not be added to the cinelerra-wide blacklist. You can either recompile the problematic plugin, or modify your own blacklist which you will have to maintain and save so as not to be written over when loading a new build.
624
625 Note the UI button in the upper right hand corner above the Reset button (figure~\ref{fig:calf}). If you click this button, a glitzy interface window comes up (if available) for changing variable values. It is possible that a bug in the LV2 plugin causes the glitzy window to appear as blank and then die, but in that case the original simple text window might still work --- in either case, if the timeline movement hangs, just detach the plugin to continue your current session. There is an environment variable that you can set,  \texttt{BC\_TRAP\_LV2\_SEGV}, to get a dump of the failure which may be helpful for debugging.
626
627 \begin{figure}[htpb]
628     \centering
629     \includegraphics[width=0.9\linewidth]{images/calf.png}
630     \caption{Screencast of simple text interface in the middle of the screen for a Calf LV2 plugin}
631     \label{fig:calf}
632 \end{figure}
633
634 When the glitzy ui is up, the simple text window remains up also since it is the cinelerra side and keeps track of the value changes so they remain in effect for further usage of the plugin. Changes to one or the other will occur in both with the exception of certain features in the glitzy window which are not communicated correctly back to cinelerra; for example a reset button --- the simple interface Reset button must be used instead. To change values in the glitzy window you use the mouse and move up or down unlike a knob that turns! (Figure~\ref{fig:calf02})
635
636 In order to test a particular plugin without bringing up cinelerra, especially for ones that do not operate, it is possible to manually display an lv2ui gui with: \\
637 \texttt{/cin-path/lv2ui <lv2-uri>} \\
638 For example:
639
640 \begin{lstlisting}[language=Bash]
641 /tmp/cinelerra-5.1/bin/lv2ui http://calf.sourceforge.net/plugins/Flanger
642 \end{lstlisting}
643
644 \begin{figure}[htpb]
645     \centering
646     \includegraphics[width=0.8\linewidth]{images/calf02.png}
647     \caption{Screencast with a Calf plugin glitzy window that appears when clicking the simple interface UI button.}
648     \label{fig:calf02}
649 \end{figure}
650
651 \section[Video Effects --- Native]{Video Effects --- Native\protect\footnote{credit to Andrea Paz for reviewing and numerous plugin descriptions and figures}}%
652 \label{sec:video_effects_native}
653
654 \subsection{1080 to 480}%
655 \label{sub:1080_to_480}
656
657 Most TV broadcasts are received with a $1920\times1080$ resolution but originate from a $720\times480$ source at the studio. It is a waste of space to compress the entire $1920\times1080$ if the only resolvable details are $720\times480$. Unfortunately resizing $1920\times1080$ video to $720\times480$ is not as simple as shrinking it.
658
659 At the TV station the original $720\times480$ footage was first converted to fields of $720\times240$. Each field was then scaled up to $1920\times540$. The two $1920\times540$ fields were finally combined with interlacing to form the $1920\times1080$ image. This technique allows a consumer TV to display the re-sampled image without extra circuitry to handle $720\times480$ interlacing in a $1920\times1080$ image.
660
661 If you merely deinterlace the $1920\times1080$ images, you would end up with resolution of $720\times240$. The \texttt{1080 to 480} effect properly extracts two $1920\times540$ size fields from the image, resizes them separately, and combines them again to restore a $1920\times480$ interlaced image. The scale effect must then be applied to reduce the horizontal size to $960$ or $720$ depending on the original aspect ratio.
662
663 The tracks to which \texttt{1080 to 480} is applied need to be at $1920\times1080$ resolution. The project settings in \texttt{settings$\rightarrow$ format} should be at least $720\times480$ resolution. The effect does not know if the first row in the $1920\times1080$ image belongs to the first row of the $720\times480$ original. You have to specify what the first row is in the effect configuration. The output of this effect is a small image in the middle of the original $1920\times1080$ frame. Use the projector to center the output image in the playback.
664
665 Finally, once you have $720\times480$ interlaced video you can either apply \texttt{Frames to Fields} or \texttt{Inverse Telecine} to further recover original progressive frames.
666
667 \subsection{1080 to 540}%
668 \label{sub:1080_to_540}
669
670 Extracts two $1920\times540$ fields from $1920\times1080$ image, resizes them separately, and combines them to $1920\times540$ interlaced image.
671
672 \subsection{Aging TV}%
673 \label{sub:aging_tv}
674
675 This effect is the one to use if you want to achieve an old movie or TV show look. It will put moving lines up and down the movie as well as putting snow on the video. Use it along with \texttt{Brightness/Contrast} and \texttt{Color Balance} to make your movie look like a really old black and white movie. This came from \url{https://effectv.com}.
676
677 \subsection{Auto Scale}%
678 \label{sub:auto_scale}
679
680 Automatically scale to a specified size.
681
682 \subsection{Blue Banana\protect\footnote{credit to Monty Montgomery programmer}}%
683 \label{sub:blue_banana}
684
685 Blue Banana is an \textit{HSL Qualifier} (HSL= hue, saturation, lightness), one of the basic tools of any grading software that are based on circumscribing a zone of the frame by extracting a chromatic key and producing a \textit{matte} in the alpha channel. Blue Banana differs not by creating a real matte, but by creating a \textit{selection mask} exclusively for use within the plugin. The BlueBanana plugin has a couple of useful purposes. It can be used for color transformation or remapping --- by isolating a specific color and then performing color change/correction on only that color. Another useful purpose is for chroma-key filtering, using multiple BlueBanana plugins on the same track. Also, it can be used in conjunction with the mask operation of the Compositor. Usage of BlueBanana may seem complicated at first, but it is necessarily so in order to get enough control to produce the desired effect simply and quickly. Just changing a single color is actually quite easy. BlueBanana is keyframable (figure~\ref{fig:bluebanana}).
686
687 The basic strategy for BlueBanana is to:
688
689 \begin{itemize}
690     \item Select a specific target color.
691     \item Create a selection region by expanding color ranges around that color.
692     \item Optionally reduce or expand the alpha plane as a regional selection mask.
693     \item Optionally apply a color remapping or transformation to the selection.
694     \item Optionally reset the output alpha to opaque, or pass the alpha to another BlueBanana plugin.
695 \end{itemize}
696
697 \begin{figure}[htpb]
698     \centering
699     \includegraphics[width=0.8\linewidth]{images/bluebanana.png}
700     \caption{Screencast showing the BlueBanana plugin control}
701     \label{fig:bluebanana}
702 \end{figure}
703
704 \subsubsection*{Just a Warning Note:}
705 \label{ssub:warning_note}
706 May use a lot of CPU and Memory because it is doing a lot of work. If you turn off the plugin on the plugin bar below the video track in the main track canvas it will stop using cpu when not in use. Or once you uncheck \texttt{Mark Selected Area}, it will no longer be using the cpu to mark the selected color area in realtime while drawing the diagonal animated pattern in the compositor window.
707
708 \subsubsection{Example Usage\protect\footnote{from original message by Rebecca}}
709 \label{sssec:example_usage}
710
711 If you just want to try this, follow these steps.
712
713 \begin{description}
714     \item[First ---] Choose your color.
715     \begin{enumerate}
716         \item Load your video, add the BlueBanana plugin to the track, bring up its control window, and uncheck any checked boxes (mostly just to avoid unexpected results).
717         \item In the Compositor window, choose the eyedropper color picker tool on the left-hand side and click on the area of the image that shows the color you want to change/correct.
718         \item In the BlueBanana plugin window, to the right of hue, click Pick. And if you want to modify saturation and value, also click on the Pick button for them. To see what it does, Pick them also.
719         \item Next, check the Mark Selected Areas box at the top right of the BlueBanana plugin window to see the selected color-matching areas which will become marked in a diagonally striped pattern.
720         \item You can now manually modify your selection in the Color Selection area in the obvious ways for hue, saturation, value and fill. The arrows to each side of the small circle widen the selected area. Move the dot and you move the range. The slider on top of the horizontal color strip shifts like the amount of the strip is dedicated to that part of the color spectrum. Fill will fill more area or less area in your selected region.
721     \end{enumerate}
722     \item[Second ---] Adjust your color choice.
723     \begin{enumerate}
724         \item There are color strips under color Adjustment which will show color changes as you modify values.
725         \item Uncheck Mark Selected Areas and check the Filter Active box to the right of Color Adjustment.
726         \item As needed, you can individually check and uncheck all the various parameters using the boxes to the left of each line. Again, these are intuitive and broadly similar to the above. The arrows at the bottom widen the range, the circle at the bottom moves the range, and the top slider, which is an arrow this time, affects distribution. It provides a little histogram effect to give you an idea of what you're changing. The fade adjusts the level of color blending. The alpha is basically the opacity of your changes.
727     \end{enumerate}
728 \end{description}
729
730 Definition of Wording/Checkboxes/Buttons/Operators are being described next. Some of the commentary was adopted from information provided by \textit{Monty Montgomery} and from questions and answers from email by \textit{Igor Ubuntu}, who did extensive testing.
731
732 \subsubsection*{Operational characteristics for the \textbf{color-related adjusters}:}
733 \label{ssub:operational_characteristic_color}
734
735 \begin{description}
736         \item[left arrow slider] operates the range minimum; the numerical value shows in the left-most textbox.
737         \item[right arrow slider] operates the range maximum; resulting numerical value is in the middle textbox.
738         \item[middle circle slider below] can move the current range up or down and the numerical results will show in the left and middle textbox. Move the dot and you move the range.
739         \item[top pad slider] operates the edge slopes (selection attack/decay) and the value will be displayed in the
740         rightmost textbox. Sharp edges are represented by 0; 100 represents smooth edges.
741         \item[top arrow] affects the distribution skew.
742 \end{description}
743
744 \subsubsection*{Operational characteristics for \textbf{Fill}:}
745 \label{ssub:operational_characteristic_fill}
746
747 \begin{description}
748         \item[left arrow slider] operates mask erosion filling. First textbox value.
749         \item[center up arrow slider] operates the fill skew midpoint. Second textbox value.
750         \item[right arrow slider] operates mask expansion filling. Third textbox value.
751         \item[top pad slider] operates the edge slopes. Right textbox value.
752 \end{description}
753
754 The textboxes are available so that you can directly type in numbers from the \textit{color wheel}. This could be helpful if duplicating previous work as it would be an instantaneous exact numerical match without having to continuously fine-tune the movement of a slider.
755
756 There are two panes separated by long horizontal lines (through the middle of the screen) in the control window of the BlueBanana plugin, clearly visible in the previous screencast. The top pane is first used to create/modify a selection, and the bottom pane is used to operate a change.
757
758 \subsubsection*{Pane 1}
759 \label{ssub:pane1}
760
761 This section is used to select the target color domain. First, a short explanation about \textit{alpha}. The alpha channel used in BlueBanana is not transparency (\textit{matte}); it is used as the \textit{Selection mask}. Alpha plane is the alpha channel of the current image. So that:
762
763 RGBA = red/green/blue color planes, alpha data plane. 
764 YUVA = luma/Cb/Cr color values, alpha data plane.
765
766 The alpha data normally is input to the blending operations in the patchbay overlay mode. The alpha data usually creates the appearance of stacking order, and determines which color planes are visible in the rendered result. When BlueBanana is used, the meaning of the alpha data is changed to the selection. It is useful to think of the alpha data as more solid when it is transparency in blending, and more selected when it is used in BlueBanana. In both cases, the greater the alpha value, the more the effect is expressed.
767
768 Usually, alpha is normalized to a range from $0$ to $1$, zero = no effect, $1$ = total effect, $0.5$ = partial effect. In both cases, alpha is what math people call an auxiliary variable. It is needed, but is not part of the answer. In this case, the answer is the visible rendered result. Alpha is like meta-data.
769
770 Let us now examine the instruments in \textbf{pane 1}:
771
772 \begin{description}
773     \item[Combine Selection] The selection is the intersection or union of two pixel masks. Mathematically, $A$ and $B$ are normalized, (scaled to between $0$ and $1$) and used as selection mask weights.
774     
775     $Intersection (\cap) = A\times B$
776     
777     $Union (\cup)= A+B-A\times B$
778     
779     where $A$ is the input alpha plane as a mask, $1$=selected, $0.4$=partially selected, and $0$=not selected; $B$ is the color selection of trims and feathers made by varying the sliders.
780     
781     The result is a new alpha plane, which will be output (if End Mask is not set). The $0\dots1$ selection values are used to weight the color transformation filters if/when they are active and operate a change. The color adjustment filters available in Pane \#$2$ can change \textit{red}, \textit{green}, \textit{blue}, and remap \textit{hue}, \textit{saturation}, \textit{value} in the pane. There is also \textit{fade} which applies to the color channels and \textit{alpha} which applies to the resulting alpha plane.
782     
783     The basic plan is to either:
784     
785     - reduce a selection area by intersection (Combine selection off) $A \times B$
786     
787     - increase a selection area by union (Combine selection on) $A+B-A\times B$
788     \item[Mask Selection] applies the current mask to the selection, such that the mask clips/expands the selection. When mask selection is enabled, the result of the and/or will be stored to the alpha result, but when mask selection is unchecked the mask is ignored and the selection is not modified. The selection is used to weight the effect of the filtering, or to control the output alpha.
789     \item[End mask] only visible when \textit{Mask Selection} is checked. End Mask causes the entire alpha plane to
790     be set to $1$. The image becomes opaque. This is usually only set in the last plugin of a stack (the stack may be just one plugin doing only color modification). In the event that a color selection mask is used with multiple, layered BlueBanana filters on the same track, the grouped BlueBanana filters may share a single mask by all enabling Mask Selection, but with only the last BlueBanana enabling End Mask. This usage pattern gives the End Mask control its name.
791     \begin{description}
792         \item[End Mask as used in Color Transformation/Remapping:] In many use cases \\
793         where you are just remapping color, you are still interested in seeing all of the picture. If this is the case, then checking End Mask on the last BlueBanana plugin will show you the entire picture. The alpha plane may be in use as a selection mask, but it may not be wanted as part of the result.
794         \item[End Mask as used in Chroma-key Filtering:] In cases where the selection is for a chroma-key, you are interested in the alpha channel for blending, like \texttt{Normal} or \texttt{SrcOver}. So for this usage of the BlueBanana, don't check the End Mask.
795     \end{description}
796     \item[Invert Selection] reverse target color domain, which is 1 minus selection.
797     \item[Mark Selected Areas] when this box is checked, the chosen colors are presented in an animated 
798     diagonally striped pattern.
799     \item[Hue] select a hue domain; click on the Pick button to select or check the box to the left of hue or uncheck to ignore.
800     \item[Saturation] select a saturation domain; click on the Pick button to select or check the box to the left.    
801     \item[Value] select a value domain; click on the Pick button to select or check the box to the left.
802     \item[Fill] will fill more area or less area of your selected region. This describes how it works. Fill control is an automated way of doing grow and shrink on the selected area, to fill in small holes, or get rid of scattered speckles. If none of the Hue, Saturation, or Value sliders are active --- meaning that the whole frame is selected --- the Fill slider will have no effect even when enabled. The word fill will appear ghosted to indicate this.
803     
804     The three lower handles in the fill slider correspond to \texttt{Shrink} (the left hand slider), \texttt{Final} (the middle slider), and \texttt{Grow} (the right hand slider). These are used in combination to alter the selection by first growing it by the amount specified by the right hand Grow slider, shrinking it to the amount specified by the left hand Shrink slider, and then growing it again to the final size specified by the middle Final slider. The top slider then feathers the resulting selection.
805     Growing the selection and then shrinking it has the effect of filling small holes in the selected area. Similarly, shrinking and then growing tends to remove small flecks of unwanted selection. The Final slider specifies the overall desired shrinkage or growth of the selection when finished. To specify a pure Grow or Shrink operation, set the Final slider and the Grow/Shrink slider to the same value and leave the other slider at zero.
806     \item[Pre-erode] this control reverses the order of operation to Shrink, then Grow, then Final. The change is subtle on most images, but overall removes more small features because it first removes flecks before filling in holes.
807 \end{description}
808
809 \subsubsection*{Pane 2}
810 \label{ssub:pane1}
811
812 This section is used to modify the color of your selection. Descriptive commentary for this pane.
813
814 \begin{description}
815     \item[Filter Active] checkbox to indicate that the modifications will be shown.
816     \item[Color Adjustment ] For Color Adjustment, RGB can be used as color weights while the HSV can transform color.
817     For the following items there are three sections on the slider. The \textit{center} section represents the nominal $0\%-100\%$ range; the \textit{left} section represents negative values, and the \textit{right} section represents values greater than $100\%$. Values can be out-of-range within BlueBanana without clipping, but they will clip once they leave the plugin.    
818     \item[RGB] affect the color channels individually.
819     \begin{description}
820         \item[Red] modification color; click the Reset button to revert to default. Values are reflected in numerical textboxes on the right-hand side.
821         \item[Green] modification color; click the Reset button to revert to default. Values are reflected in numerical textboxes on the right-hand side.
822         \item[Blue] modification color; click the Reset button to revert to default. Values are reflected in numerical textboxes on the right-hand side.
823     \end{description}
824     \item[HSV] reorient the color spectrum, and affect all of the color channels simultaneously.
825     \begin{description}
826         \item[Hue] a single numerical value will appear in the right-side box. Click the Reset button for default.
827         \item[Saturation] for modifying the saturation; click the Reset button to revert to default. Values are reflected in numerical textboxes on the right-hand side.
828         \item[Value] for modifying the value; click the Reset button to revert to default. Result is reflected in the numerical textboxes on the right-hand side.
829     \end{description}
830     \item[Fade] controls the entire color re-mapping, and does nothing if no color adjustment is active.
831     \item[Alpha] controls the output alpha (this is not available when End Mask is set); click the Reset button to revert to default. Result is reflected in the numerical textboxes on the right-hand side.
832 \end{description}
833
834 Let's see two examples of HowTo:
835
836
837 \subsubsection*{BlueBanana Use Case \#1: (Color Transform/Remapping)}
838 \label{ssub:bb_use_case_1}
839
840 \begin{itemize}
841         \item Load a video track, and add the BlueBanana plugin to your video. The alpha channel is usually all opaque. This serves as an initial full screen selection mask.
842         \item Open the controls, and start with all boxes unchecked. Now reduce the selection using the top pane in intersection mode (that is \texttt{Combine Selection} is unchecked) to begin the effect.
843         \item Use the \textit{eyedropper} on the compositor window to choose a particular color.
844         \item Click on the 3 plugin Pick boxes on the right side of each line of HSV to get the color selection.
845         \item Check \textit{Mark Selected Area}. The affected zones will be identified on the composer.
846         \item Adjust the selection using the HSV and Fill sliders of the top pane. The selection mark will be updated as you operate the controls. The composer mask striping will be strongest as the mask is nearer full selection.
847         \item Now uncheck \texttt{Mask selected area} \& check \texttt{Filter Active} to begin Color Adjustment.
848         \item Enable any needed colorspace modifiers, RGB / HSV sliders, and setup the color changes by moving the sliders. The current output may be the desired output.
849         \item Enable \texttt{Mask Selection} and the alpha output will pass the selection mask to the image alpha channel. This can be used as a very flexible chroma-key filter. It also allows more plugins to be stacked and more selection information to be added, either by intersections or unions with other selections.
850         \item \texttt{End Mask} simply sets the output image alpha to opaque. This is normally used to end a stack of BlueBanana plugins, and render the entire image with a complex selection.
851 \end{itemize}
852
853 \subsubsection*{BlueBanana Use Case \#2:}
854 \label{ssub:bb_use_case_2}
855
856 This case uses stacked BlueBanana plugins working like \textit{chroma-key} filters. It assumes you have already learned how to operate the plugin.
857
858 \begin{itemize}
859         \item Bring up 2 tracks of video media --- one for foreground and one for background.
860         \item Add 2 BlueBanana plugins on the first track. Turn off all checkboxes in both plugins.
861         \item On the top plugin, use the top pane to create a selection mask, using \texttt{Mark Selected Areas}.
862         \item Turn off top plugin \texttt{Mark Selected Areas}, and disable the top plugin via the plugin title bar on/off.
863         \item Create another selection using the second plugin's mask, using \texttt{Mark Selected Areas}.
864         \item Turn on the top plugin. Make sure both plugins \texttt{Mark Selected Areas} is off.
865         \item Check \texttt{Mask Selection} and \texttt{Filter Active} in both.
866         \item Check \texttt{Combine Selection} on second BlueBanana to see the final results.
867 \end{itemize}
868
869 You will see that there is intersection of the full plane with the first chosen regions, so the $alpha = 0$ everywhere but the area you picked and you see through. And $alpha = 1$, where the intersection selection was 1. The Normal blend shows you the track on top in these regions (the foreground track where $alpha = 1$).
870
871 If you are building an alpha selection mask by first intersection and then union, the top BlueBanana should not change the colors or the bottom plugin will need to target the remapped colors since that is the input to the lower BlueBanana.
872
873 \subsection{Blur}%
874 \label{sub:blur}
875
876 This is a Gaussian type blur. Other blur plugins --- \textit{Linear}, \textit{Motion}, \textit{Radial}, and \textit{Zoom} ---are described later. This plugin is keyframable. Blur is used to blur a video track via the following parameters:
877 \begin{description}
878     \item[Horizontal and vertical] values are used to tell which one of the fields blurring affects; can be both.
879     \item[Radius] use this dial to define the amount of blur to apply.
880     \item[Alpha determines radius] use alpha to define the amount of blur to apply. (radius=gray value of alpha)
881     \item[Blur alpha, red, green, blue] specifies which color channels is to be blurred.
882 \end{description}
883
884 \subsection{Brightness/Contrast}%
885 \label{sub:brightness_contrast}
886
887 To brighten a dark shot, or add light, use this plugin. Do not overuse the effect or you risk degrading your video quality.
888 The \texttt{Brightness} slider moves up or down the values of the entire channel and corresponds to the \textit{Master Offset} of the various grading programs.
889 The \texttt{Contrast} slider expands or narrows the brightness values of the entire channel; corresponds to the use of the \textit{cursors} (small triangles) in the \textit{Histogram} plugin.
890 Use the effect along with keyframing to brighten a long shot that is dark at the beginning but bright at the end. Generally you will want to change the brightness and contrast about the same amount (for example - darkness $28$, contrast $26$) so that your original colors are kept intact. This effect is also keyframable (figure~\ref{fig:brightness}).
891
892 \begin{figure}[htpb]
893     \centering
894     \includegraphics[width=0.6\linewidth]{images/brightness.png}
895     \caption{How it works Brightness and Contrast}
896     \label{fig:brightness}
897 \end{figure}
898
899 \subsection{BurningTV}%
900 \label{sub:burningtv}
901
902 Makes your video burn where there are small light colored patches of video. This came from \url{https://effectv.com}.
903
904 \subsection[C41]{C41\protect\footnote{credit Florent Delannoy, original program code author, and Edouard Chalaron}}%
905 \label{sub:c41}
906
907 The C41 plugin takes a $16\,bit C41$ digital intermediate negative film as input and outputs a positive image. It became necessary because $C-41$ negatives can fade or color-shift over time which was a problem early on. It is still important today because there is a large amount of documentaries, video clips, and other media out there that was shot on super $16$ film. This works for RGB-float, RGB, and also YUV variations.
908
909 There are two sets of data --- the scanned input values and your corrected values. Simple functionality of the plugin is to compute the data, transform to get corrected values, then apply that.
910
911 Basic usage strategy:
912 \begin{enumerate}
913     \item first time the controls come up, nothing is checked and everything is set to $0$
914     \item check the box \texttt{Compute negfix values} to see the current media input values
915     \item check \texttt{Activate processing} and you see a $1-colored$ screen in the Compositor due to zero values
916     \item check the \texttt{Apply values} box to see the input values on the left side propagate to the right side
917     \item check \texttt{Apply default box} if you want to make sure that the borders of the image are not used
918     \item correct the output values as desired on the applied right side
919 \end{enumerate}
920
921 It is important to note as you play or change the frame, the plugin re-computes the data as you move along, but it is not propagated to the applied side.
922
923
924 \paragraph{Checkboxes:}
925     \begin{description}
926         \item[Activate processing] when checked, the c41 operation is used to render the image.
927         \item[Compute negfix values] computes the current negative values of the image (inside the box).
928         \item[Show active area] draws horizontal and vertical grid lines displaying the boxed area.
929         \item[Postprocess] when checked, applies contrast/brightness values as defined in $coef\frac{1}{2}$.        
930     \end{description}
931 \paragraph{Values:}
932     \begin{description}
933         \item[Compute negfix values] (left side) and
934         \item[negfix values to apply] (right side):
935         \item[Min/Max R/G/B] minimum and maximum values for Red, Green, and Blue.
936         \item[Light] value of light; a smaller number is lighter.
937         \item[Gamma G/B] values for gamma Green and Blue.
938         \item[Contrast] simple color contrast.
939         \item[Brightness] white brightness.
940     \end{description}
941 \paragraph{Buttons:}
942     \begin{description}
943         \item[Apply values] copies computed RGB/Light/Gamma/Contrast/Bright from negfix to applied values.
944         \item[Apply default box] copies default computed Box column/row from negfix to applied values.
945     \end{description}
946 \paragraph{Shading box:} The boxing option allows for calculating the inversion of the digital negatives in a given area of the frame as opposed to the entire frame. The program will automatically calculate the columns and rows to shave from the frame when compute negfix values is checked. A default box area is initially calculated, called the shaving box, based on where the min/max difference in a row/column is less than the program defined tolerance. This row/column minimum and maximum difference must be greater than 0.05. The effect is to cut away the border areas with constant color. If you check the Show active area, you can see the box in the compositor window. The boundary search is constrained to a range of 0.1 to 0.9 times the frame dimensions, to create a 10 percent shaved margin to avoid over-scan and negative edge bleeding. Manual adjustment of the shaving box is controlled via the four sliders on the bottom right which move each of the left, right, top and bottom shaving margins. The slider bar new values automatically take effect as you move the box and you will see the right-hand side applied values change. When you have either the rows or the columns where the minimum slider is greater than or equal to the maximum slider, the default box will be in effect instead.
947
948 \paragraph{Optional postprocessing:} In order to have the values of Contrast and Brightness take effect, you must check the Postprocess checkbox.
949 \begin{description}
950     \item[Contrast] is the difference in brightness between objects or regions.
951     \item[Brightness] refers to the overall lightness or darkness of the image.
952 \end{description}
953
954 Figure~\ref{fig:c41} shows the C41 controls on the left and part of the Compositor window with grid lines showing the default shading box since the Show active area box is checked. Changes have been made to the left-hand side original computed values as seen in the right-hand side such as Gamma G which contains the hairline cursor and has a partial red outline value box.
955
956 \begin{figure}[htpb]
957     \centering
958     \includegraphics[width=0.9\linewidth]{images/c41.png}
959     \caption{C41 - Control window and compositor window in action}
960     \label{fig:c41}
961 \end{figure}
962
963 \subsection{Chroma Key}%
964 \label{sub:chroma_key}
965
966 This effect erases pixels which match the selected color. They are replaced with black if there is no alpha channel and transparency if there is an alpha channel. In this case, you create a matte in the alpha channel, which is not visible to us. The selection of color model is important to determine the behavior (figure~\ref{fig:chroma-key}).
967
968 \begin{figure}[htpb]
969     \centering
970     \includegraphics[width=0.7\linewidth]{images/chroma-key.png}
971     \caption{Chroma Key control window}
972     \label{fig:chroma-key}
973 \end{figure}
974
975 Chroma key uses either the \textit{lightness} or the \textit{hue} to determine what is erased. Use value singles out only the lightness to determine transparency.
976 Select a center color to erase using the \texttt{Color} button. Alternatively a color can be picked directly from the output frame by first using the \textit{color picker} in the compositor window and then selecting the \texttt{Use color picker} button. This sets the chroma key color to the current color picker color.
977
978 Be aware that the output of the chroma key is fed back to the compositor, so selecting a color again from the compositor will use the output of the chroma key effect. The chroma key should be disabled when selecting colors with the color picker.
979
980 If the lightness or hue is within a certain \texttt{threshold} it is erased. Increasing the threshold determines the range of colors to be erased. It is not a simple on/off switch. As the color approaches the edge of the threshold, it gradually gets erased if the \texttt{slope} is high or is rapidly erased if the slope is low. The slope as defined here is the number of extra values flanking the threshold required to go from opaque to transparent.
981
982 Normally threshold is very low when using a high slope. The two parameters tend to be exclusive because slope fills in extra threshold. The slope tries to soften the edges of the chroma key but it does not work well for compressed sources. A popular softening technique is to use a maximum slope and chain a blur effect below the chroma key effect to blur just the alpha.
983
984 \subsection[Chroma Key (HSV)]{Chroma Key (HSV)\protect\footnote{Credit for Plugin by Jerome Cornet http://jcornet.free.fr/linux/chromakey.html}}%
985 \label{sub:chroma_key_hsv}
986
987 Chroma Key (HSV) (figure~\ref{fig:chroma-key-hsv}) replaces a color with another color or transparency using HSV variables; it is frequently used to remove a color from a video to composite with another image. This process is generally referred to as green screen or blue screen process (because of the color that is keyed out). More information: \url{http://en.wikipedia.org/wiki/Chromakey}
988
989 \begin{figure}[htpb]
990     \centering
991     \includegraphics[width=0.6\linewidth]{images/chroma-key-hsv.png}
992     \caption{Keying a green screen with Chroma Key (HSV)}
993     \label{fig:chroma-key-hsv}
994 \end{figure}
995
996 \subsubsection*{Requirements}
997 \label{ssub:requirements}
998
999 The subject in the movie should have a good background. The lighting is crucial and good lighting during production will save you time with much less effort than in post-production.
1000 Here we assume that we have a good video, filmed on green (or blue) screen that we want to use. Important: Make sure you are using a color model that has an alpha channel, such as \textit{RGBA8}, \textit{RGBAFloat}, \textit{YUVA8}. To change color model, go to \texttt{Settings$\rightarrow$ Format$\rightarrow$ Color Model}.
1001
1002 \subsubsection*{Usage}
1003 \label{ssub:usage}
1004
1005 As in any other effect, add it to the timeline in the main window. You can tweak each parameter in order to improve the keying.
1006
1007 Start with \texttt{Hue Tolerance} at $10\%$, \texttt{Min Brightness} at $0$, \texttt{Max brightness} at $100\%$, \texttt{Saturation offset} at $0$, \texttt{Min Saturation} at $0$, \texttt{In Slope} at $0$, \texttt{Out Slope} at $0$, \texttt{Alpha Offset} at $0$ (that’s mid-way through), \texttt{Spill Threshold} at $0$, \texttt{Spill Compensation} at $100\%$. At any time, you can check what the Mask looks like by clicking on \texttt{Show Mask}. This will output a black and white image of the mask (\textit{matte}).
1008
1009 \begin{description}
1010     \item[Key color:] Select the key color (green, blue, etc) using the color wheel or the color picker. Remember, only the Hue matters, not Saturation or Value. To use the color picker, click on the \texttt{color picker} icon in the Compositor window, then click on the color you want in the Compositor window. Finally  in the Chromakey (HSV) parameters window, click on \texttt{Use Color Picker}.
1011     \item[Hue Tolerance:] Because there are slight variations in lighting, the background will not be in a uniform key color hue. Increase or decrease the Hue tolerance to mask out the background. If there are dark spots that are keyed out that shouldn’t be, it can be corrected later.
1012     \item[Brightness:] ncrease \texttt{Min Brightness} so that only the background is masked out, and not parts of the foreground. You can also reduce \texttt{Max Brightness} if some clear areas are keyed out (useful for very dark backgrounds).
1013     \item[Saturation:] Increase \texttt{Min Saturation} so that only the background is masked out, and not parts of the foreground. \texttt{Saturation Offset} can be used to change this, but for now leave it set to $0$.
1014 \end{description}
1015
1016 Check what it looks like at this stage, your mask should be pretty clean. Toggle \texttt{Show Mask} to check what it looks like, it should be \texttt{OK}. If not, repeat steps $1 to 4$ to get a better key. The rest of the controls are useful to smear the mask to help compositing later on. They will help you to make your key look much cleaner.
1017
1018 \begin{description}
1019     \item[Slope:] For now, the mask is a full on/ full off mask that can be really harsh and not necessarily what you are looking for. \texttt{In Slope} and \texttt{Out Slope} will help you to smooth that key. In Slope leaves more colors in the mask, Out Slope takes more colors out of the mask. The colors that are borderline in the mask will see their alpha channel reduced by half instead of being completely on or off.
1020     \item[Alpha Offset] This control offsets the whole alpha channel by some amount. Be sure to know what you are doing if you change it from the default value of $0$.
1021     \item[spill light control:] This step helps you remove the green or blue halo around the edges of the mask. It does so by removing the saturation of pixels that have a similar hue to the key color (turning them into grey instead of green or blue). \texttt{Spill Compensation} controls the amount of de-saturation. If you start with Spill Compensation at $100\%$, slowly increase the \texttt{Spill Threshold} until the remaining green or blue areas turn grey. Then reduce Spill Compensation until the image looks good.
1022 \end{description}
1023
1024 Now the mask is probably still very harsh, so just below the Chromakey (HSV) plugin, add a \textit{Blur} effect, and select only the \textit{Alpha channel}, with a radius of $2$ or $3$ (more if you really want to soften the edges). This will significantly help the keying.
1025
1026 \subsection{Color 3 Way}%
1027 \label{sub:color_3_way}
1028
1029 Together with \textit{Histogram Bezier / Curves} is the main tool of Color Grading because you can modify the colors of \textit{Shadows}, \textit{Midtones}, and \textit{Highlights} as desired. Color 3 Way is keyframable (figure~\ref{fig:color3way}).
1030
1031 \begin{figure}[htpb]
1032     \centering
1033     \includegraphics[width=0.8\linewidth]{images/color3way.png}
1034     \caption{Color 3 Way control window}
1035     \label{fig:color3way}
1036 \end{figure}
1037
1038 \begin{itemize}
1039     \item It allows you to vary the \textit{contrast} of the image using the slider Value, always acting separately on shadows, midtones, and highlights and thus resulting in very precise application.
1040     \item Allows you to automate the \textit{white balance} by simply choosing a neutral color in the output of the Compositing window using the Color Picker and pressing the corresponding button in the plugin.
1041     \item Allows you to vary the \textit{Saturation} with sliders in the same manner as contrast was varied by the Value slider. For istance, to decrease the incidence of color dominants present in the shadows or in the highlights, vary the Saturation.
1042     \item With the \textit{color wheels} you can make very sophisticated adjustments to the shades of the images, in each of the three main areas of shadows, midtones and highlights.
1043     \item Allows you to copy exactly the setting of one zone to the other two zones using \texttt{Copy to all} button.
1044 \end{itemize}
1045
1046 This plugin allows maximum control over the result and maximum precision of adjustments when used simultaneously with the control monitors, i.e. \textit{Waveform}, \textit{RGB Parade} and \textit{Vectorscope}. It is important to keep in mind that the three zones are not clearly separated, but slightly overlapping. This results in less precision but looks better for more smooth shades. By varying the values on the color wheels all RGB channels are affected simultaneously, which can result in unwanted color dominance. Saturation is also affected and must therefore be monitored.
1047 To use more precisely, drag the \textit{crosshair} with the mouse in the desired area and then adjust in steps of $0.001$ using the \texttt{up/down} and \texttt{right/left arrows} on the keyboard.
1048 The most common use cases (but can be adapted to virtually any situation) of the plugin are:
1049
1050 \begin{itemize}
1051     \item White balancing.
1052     \item Expand/compress contrast.
1053     \item Mitigate under and over exposure.
1054     \item Balance colors, i.e. eliminate color dominance.
1055     \item Color matching Shot to Shot.
1056     \item Create a Stylized look.
1057 \end{itemize}
1058
1059 \subsection{Color Balance}%
1060 \label{sub:color_balance}
1061
1062 Video Color Balance is a great effect to use along with Brightness/Contrast and Hue/saturation to try to compensate for possible errors in filming (low lighting, for example). It can do so much without greatly lowering the quality of the video. With it you can change the colors being sent to output \textit{CMY} (Cyan, Magenta, Yellow) or \textit{RGB} (Red, Green, Blue). Color Balance is also keyframable.
1063
1064 Since \textit{complementary colors} are neutralized, to eliminate a \textit{color cast}, the pertinent slider is moved in the direction of the complementary color. If you \texttt{Lock parameters} you get the same \textit{Color Offset}, that is the fourth color wheel in the grading programs. The parameters of the plugin are:
1065
1066 \begin{description}
1067     \item[CMY/RGB sliders:] allows you to adjust the colors.
1068     \item[Preserve Luminosity:] Adjusts colors while keeping the overall brightness constant.
1069     \item[Lock Parameters:] works as a Color Offset.
1070     \item[White Balance] used in conjunction with the \textit{color picker} on a neutral color of the output, it will automatically balance the white.
1071 \end{description}
1072
1073 \subsection{CriKey}%
1074 \label{sub:crikey}
1075
1076 The Chroma Interpolation Key plugin, CriKey, is a regionally based chroma key with interpolation (figure~\ref{fig:crikey}). This is useful when you only want 1 or some specific zones to be defined by the chroma key as opposed to the entire image. Its most significant feature is that you can select several regions of interests and of different colors as opposed to only $1$.
1077
1078 \begin{figure}[htpb]
1079     \centering
1080     \includegraphics[width=0.6\linewidth]{images/crikey.png}
1081     \caption{three active point created in CriKey}
1082     \label{fig:crikey}
1083 \end{figure}
1084
1085 To start, if not already checked, turn on drag. In the composer window select an area of a certain color by clicking on that point with the \texttt{right mouse button} and check to see that it is enabled with an $*$ in the \texttt{E} field. The color of the area is used to define the region of interest and then you can use the \texttt{threshold} slider to designate the tolerance variation. This creates a region that is the chroma key selection and a fill will be performed in that area, but only within that region. So, say for example, a red colored area was chosen, only the red color inside the region is selected --- not that color red in the entire image. The drag capability makes it easy to check a point before right clicking it to see the effect. You will want to turn off drag when you are finished with CriKey so that it does not interfere with other compositor functions.
1086
1087 \begin{description}
1088     \item[Draw mode:] options let you use \textit{Alpha} for see-thru, \textit{Edge} to just outline the edges of the region, or \textit{Mask} to block. The pixels which match the selected color are replaced by black if Mask is chosen or see-thru/transparent if Alpha.
1089     \item[X, Y:] points coordinate.
1090     \item[Buttons:] \textit{New} to create a new point, \textit{Up/Dn} to move highlighted point up or down \textit{Del} to delete the highlighted point.
1091     \item[Threshold:] slider goes from $0\, to\, 1$. Increasing the threshold, increases the area to be filled or masked. You can also use the \textit{mouse wheel} to scroll the slider.
1092     \item[Drag:] for ease of use.
1093     \item[Reset:] button to revert to only the default middle point with all others being deleted.
1094     \item[ListBox:] \texttt{E} for Enabled with $*$ marking that; \texttt{X} is the point’s $x$ coordinate; \texttt{Y} is the point’s $y$ coordinate; \texttt{T} is the threshold value of $X,Y$ point; \texttt{Tag} represents the \# of the selected 
1095     point.
1096     \item[Hints:] for usage shortcuts.
1097 \end{description}
1098
1099 \subsubsection*{Some notable caveats}
1100 \label{ssub:some_notable_caveats}
1101
1102 \begin{enumerate}
1103     \item When choosing an area that has variations of the same color within a region, for less work and for the best results, choose an average color in that region instead of an extreme end of that color.
1104     \item If the threshold is set appropriately you can see the edges which is helpful.
1105     \item The mask is computed and shows the fill region.
1106     \item Use the Gradient plugin to substitute a different color for the selected area.
1107 \end{enumerate}
1108
1109 Figure~\ref{fig:crikey01} and figure~\ref{fig:crikey02} shows how moving the Threshold slider with the Point selected blacks out the single region which has the darker brown hills in it. Because the edge was located, any of the same color in the rest of the video would not be blacked out.
1110
1111 \begin{figure}[htpb]
1112     \centering
1113     \includegraphics[width=0.8\linewidth]{images/crikey01.png}
1114     \caption{The screenshot shows the compositor with some default settings in the controls window.}
1115     \label{fig:crikey01}
1116 \end{figure}
1117
1118 \begin{figure}[htpb]
1119     \centering
1120     \includegraphics[width=0.8\linewidth]{images/crikey02.png}
1121     \caption{same screenshot with moving Threshold}
1122     \label{fig:crikey02}
1123 \end{figure}
1124
1125 \subsubsection*{Usage steps}
1126 \label{ssub:usage_steps}
1127
1128 \begin{enumerate}
1129     \item Click \textit{Reset} (there will be a single $X,Y$ coordinate point that is in the middle and not enabled)
1130     \item Check to make sure \textit{Drag} is on.
1131     \item In the Compositor, right click on area of interest and an $X,Y$ coordinate will appear in the listbox.
1132     \item Click on the \textit{E} Enabled field next to this latest point and an $*$ asterisk will show.
1133     \item Now you will see an area turn black so use the \textit{Threshold} slider to only black out the area of interest.
1134     \item Repeat steps $3-5$ until you have selected all of the desired areas.
1135     \item Finally, turn off \textit{drag} so as not to interfere with other compositor functions
1136 \end{enumerate}
1137
1138 \subsection{DeScratch}%
1139 \label{sub:descratch}
1140
1141 The descratch video plugin can be used to remove vertical scratches from film. It can also be used, after image rotation, to remove horizontal noise lines that may appear on analog \textit{VHS} captures. For best results \textit{YUV} should be the video format; however if your format is \textit{RGB}, it will first be converted to YUV. There are many tuneable parameters necessary to get good results for your specific film.
1142
1143 Figure~\ref{fig:descratch01} shows a list of the parameter descriptions:
1144
1145 \begin{figure}[htpb]
1146     \centering
1147     \includegraphics[width=0.8\linewidth]{images/descratch01.png}
1148     \caption{DeScratch control window}
1149     \label{fig:descratch01}
1150 \end{figure}
1151
1152 \begin{figure}[htpb]
1153     \centering
1154     \includegraphics[width=0.8\linewidth]{images/descratch02.png}
1155     \caption{Various parameters of DeScratch}
1156     \label{fig:descratch02}
1157 \end{figure}
1158
1159 \begin{description}
1160     \item[threshold] instantaneous slope value; chroma difference in numerical pixels.
1161     \item[asymmetry] maximum asymmetry of surrounding
1162     pixels.
1163     \item[Mode] \textit{None}; \textit{Low}=black; \textit{High}=white; \textit{All}=both;
1164     \textit{y} --- processing mode for \textit{luma} plane; 
1165     \textit{u}--- processing mode for \textit{chroma u} plane;
1166     \textit{v} --- processing mode for \textit{chroma v} plane.
1167     \item[width min/max] minimal scratch width in pixels and maximum scratch width in pixels.
1168     \item[len min/max] percent minimal scratch length and percent maximum scratch length.
1169     \item[len blur] scaled radius of vertical blur for frame
1170     analysis.
1171     \item[len gap] number of pixels for maximum vertical gap
1172     to be closed.
1173     \item[max angle] maximal angle to vertical in degrees.
1174     \item[fade] percent of how much it fades to and how much it. Uses between before image and blurry image.
1175     \item[border] pixel thickness of border near scratch for partial restoration.
1176     \item[Mark] shows the potential scratch lines for ease of viewing and for debugging. It shows chosen pixels in the color green, close but still rejected in yellow, and extreme pixels in the color red. This makes it easy to vary some parameters to choose more or fewer scratch lines.
1177     \item[Reset] activating this button returns all of the parameters to their default values.
1178 \end{description}
1179
1180 Figure~\ref{fig:descratch} shows a before and after DeScratch scenario. With \textit{Mark} set, you can see the black lines which indicate what the program was looking at to determine the scratches to remove.
1181
1182 \begin{figure}[htpb]
1183     \centering
1184     \includegraphics[width=0.9\linewidth]{images/descratch.png}
1185     \caption{Original video with scratch; Option Mark selected and Final video}
1186     \label{fig:descratch}
1187 \end{figure}
1188
1189 \subsection{Decimate}%
1190 \label{sub:decimate}
1191
1192 This is used to decrease the frame rate of a video. Changing the frame rate means eliminating a frame for any given number of frames ($1 in N$); but if frames that are important for visual continuity are deleted, temporal artifacts arise: flickering, slowdowns, accelerations, etc. The Decimate filter maintains a higher quality because it first eliminates duplicate frames or frames that are most similar, thus limiting the appearance of artifacts. It is often used after the \texttt{Invert Telecine} plugin to make the video more smooth.
1193
1194 One use of the decimate effect can be applied to a DVD to convert the 29.97\,\emph{fps} video to the 23.97\,\emph{fps} film rate, but the effect can take any input rate and convert it to any lower output rate. The output rate of decimate is the project frame rate. The input rate is set in the decimate user interface. To convert 29.97\,\emph{fps} progressive video to 23.97\,\emph{fps} film, apply a decimate effect to the track. Set the decimate input rate to 29.97 and the project rate to 23.97.
1195
1196 Keep in mind that every effect layered before decimate, processes video at the decimate input rate and every effect layered after decimate, processes video at the project frame rate. Computationally intensive effects should come below decimate.
1197
1198 \subsection{Deinterlace}%
1199 \label{sub:deinterlace}
1200
1201 The deinterlace effect has evolved over the years to deinterlacing and a whole lot more. In fact two of the deinterlacing methods, \texttt{Inverse Telecine} and \texttt{Frames to Fields}, are separate effects. The deinterlace effect offers several variations of line replication to eliminate comb artifacts in interlaced video. It also has some line swapping tools to fix improperly captured video or make the result of a reverse effect display fields in the right order.
1202
1203 \subsection{Deinterlace-CV}%
1204 \label{sub:deinterlace_cv}
1205
1206 Selection of deinterlacing mode for your video to eliminate comb artifacts (figure~\ref{fig:deinterlace}).
1207
1208 \begin{figure}[htpb]
1209     \centering
1210     \includegraphics[width=0.7\linewidth]{images/deinterlace.png}
1211     \caption{Pulldown menu}
1212     \label{fig:deinterlace}
1213 \end{figure}
1214
1215 \subsection{Delay Video}%
1216 \label{sub:delay_video}
1217
1218 Delay the video by some number of seconds.
1219
1220 \subsection{Denoise Video}%
1221 \label{sub:denoise_video}
1222
1223 Denoise video (figure~\ref{fig:denoise}).
1224
1225 \begin{figure}[htpb]
1226     \centering
1227     \includegraphics[width=0.5\linewidth]{images/denoise.png}
1228     \caption{Control window of the DeNoise plugin}
1229     \label{fig:denoise}
1230 \end{figure}
1231
1232 \subsection{Difference key}%
1233 \label{sub:difference_key}
1234
1235 The difference key creates transparency in areas which are similar between two frames. The Difference key effect must be applied to two tracks. One track contains the action in front of a constant background and another track contains the background with nothing in front of it. Apply the difference key to the track with the action and apply a \texttt{shared effect} of it to the track with the background. The track with the background should be \texttt{muted} and underneath the track with the action and the color model should have an alpha channel. It’s hard to get good results.
1236
1237 Pixels which are different between the background and action track are treated as opaque. Pixels which are similar are treated as transparent. Change \texttt{threshold} in the difference key window to make more pixels which are not the same color transparent. Change \texttt{slope} to change the rate at which the transparency tapers off as pixels get more different. The slope as defined here is the number of extra values flanking the threshold required to go from opaque to transparent. A high slope is more useful with a low threshold because slope fills in extra threshold.
1238 \texttt{Use value} causes the intensity of pixels (\textit{luma}) to be compared instead of the color. Applying a \texttt{blur} to the top track with just the alpha channel blurred can soften the transparency border (figure~\ref{fig:diff-key}).
1239
1240 \begin{figure}[htpb]
1241     \centering
1242     \includegraphics[width=0.8\linewidth]{images/diff-key.png}
1243     \caption{Control window of the DeNoise plugin}
1244     \label{fig:diff-key}
1245 \end{figure}
1246
1247 \subsection{DotTV}%
1248 \label{sub:dottv}
1249
1250 Puts various size dots over the picture to simulate TV effect. This came from: \url{https://effectv.com}.
1251
1252 \subsection{Downsample}%
1253 \label{sub:downsample}
1254
1255 Downsampling is the process of reducing the size of an image by throwing out data, reducing sampling rate.
1256
1257 \subsection{Edge}%
1258 \label{sub:edge}
1259
1260 Display only the edges of the video throughout the image.
1261
1262 \subsection{Fields to frames}%
1263 \label{sub:fields_to_frames}
1264
1265 See the theory description in the \texttt{Frames to Fields} plugin. This effect reads frames at twice the project framerate, combining two input frames into a single interlaced output frame. Effects preceding fields to frames process frames at twice the project frame rate. Each input frame is called a field.
1266
1267 Fields to frames needs to know what field corresponds to what lines in the output frame. The easiest way to figure it out is to try both options in the window. If the input fields are the result of a line doubling process like frames to fields, the wrong setting results in blurrier output. If the input fields are the result of a standards conversion process like \texttt{1080 to 480}, the wrong setting will not make any difference.
1268
1269 \subsection{Flip}%
1270 \label{sub:flip}
1271
1272 This effect flips a video track either vertically or horizontally.
1273
1274 \subsection{Frames to fields}%
1275 \label{sub:frames_to_fields}
1276
1277 \subsubsection*{Theory behind the Frames to Fields and Fields to Frames plugins}
1278 \label{ssub:theory_frames_fields}
1279
1280 Historically, CRT-type TVs used interlaced signals to save bandwidth. An interlaced video consists of two \textit{fields} that are read and drawn on the screen one after the other. Each field must be played at a framerate double that of the resulting video. In two steps the complete frame will be reconstructed. 
1281
1282 frame 1 $\implies$ F1-field1 (\textit{Top} or \textit{Odd}), F1-field2 (\textit{Bottom} or \textit{Even})
1283
1284 frame 2 $\implies$ F2-field1, F2-field2
1285
1286 Interlaced video reading: $F1-f1$ then $F1-f2$ then $F2-f1$ then $F2-f2$ \dots
1287 There may be visual problems if the Top type interlacing is read according to a Bottom scheme. So it's important to know if a video is Top or Bottom. Generally an \textit{HD} video is Top; a \textit{DV} video (both PAL and NTSC) is Bottom; \textit{SD} (PAL) is Top; \textit{SD} (NTSC) is Bottom (but not always). Instead, high-definition videos need to be more compressed and this contrasts with the interlacing that is little and badly compressible, so modern videos are mostly \textit{progressive}.
1288
1289 \subsubsection*{In Cinelerra-GG}
1290 \label{ssub:in_cin_gg}
1291
1292 \begin{enumerate}
1293     \item upload an interlaced video to the Timeline and Resources and play it for viewing.
1294     \item The video presents visual artifacts because PC monitors are progressive.
1295     \item In the Resources window, open the media \texttt{Info} with the right mouse button. Below you can see that the \texttt{Fix interlacing checkbox} is active. It has four options that try to deinterlace the video automatically: \textit{Unknown}, \textit{Top Fields first}, \textit{Bottom Fields first}, and \textit{Not interlaced}.
1296     \item If \texttt{Fix interlacing} is deactivated, \texttt{Interlacing correction} becomes active with three options: \textit{Do
1297     nothing}, \textit{Shift up 1 pixel} and \textit{Shift down 1 pixel}. These are manual settings and are more effective
1298     than automatic interlacing fixes.
1299     \item If we want to use the \texttt{Frames to Fields} plugin we have to configure it and act manually.
1300 \end{enumerate}
1301
1302 Now for the practical use of this plugin which applies the operation reverse to the \texttt{Fields to Frames} plugin. It extracts the two interlaced fields stored in alternating lines of interlaced source footage and outputs them as separate full frames. The alternating lines missing on each output frame are interpolated.
1303
1304 This plugin is only useful if its output is pulled with doubled framerate with respect to the source footage. One typical usage scenario is to do \textit{masking}, \textit{scaling} and \textit{translating} on interlaced footage without the need to destroy the additional temporal information contained in such source material. This is helpful if your intended target format is interlaced. If on the other hand, you just want to target a progressive display (for example, you create video for display on a computer monitor solely) then it is much more convenient to de-interlace the source material prior to any further processing.
1305
1306 \subsubsection*{Processing interlaced footage without deinterlacing}
1307 \label{ssub:processing_interlace_footage}
1308
1309 \begin{enumerate}
1310     \item Create a new project with doubled frame rate. That is, make it $50\,fps$ if your source footage is $25i$. 
1311     In \texttt{Resources$\rightarrow$ Media$\rightarrow$ Info} \\ uncheck \texttt{Fix Interlacing} and set \texttt{Interlace Correction} to \textit{Do nothing}.
1312     \item Insert your source footage onto a video track in the timeline. Now, Cinelerra will playback each
1313     frame of your footage twice. There will be visual artifacts because the video is interlaced and the
1314     monitor is progressive.
1315     \item Apply the \texttt{Frames to Fields} effect. Be sure to choose the correct field order. If we know or believe that the original video is \textit{Top First} let's try it first, but it doesn't have to be the right solution. The only way is to playback and look for visual artifacts.
1316     \item Then apply any further effects afterwards, including translations, scaling, slow motion, precise
1317     frame-wise masking or use of the motion tracker plugin.
1318     \item Render your project to an intermediate clip. Be sure to choose a rather lossless video codec, for
1319     example \textit{Motion-JPEG-A} or even \textit{uncompressed YUV} if you have plenty of storage.
1320     \item Insert the intermediate clip into your original project. Make sure the doubled framerate has been
1321     detected correctly by Cinelerra (by looking in the clip's media \texttt{info} in the media resources folder).
1322     \item Apply the \texttt{Fields to frames} effect to the intermediate clip. This will combine two adjacent fields
1323     into one interlaced field with the original frame rate.
1324     \item Do the final render on your original project. Now there will be no visual artifacts on the monitor.
1325 \end{enumerate}
1326
1327 \subsection{Freeze Frame}%
1328 \label{sub:freeze_frame}
1329
1330 In its simplest form, highlight a region of the track to freeze, drop the \texttt{freeze frame} effect on the highlighted region, and the lowest numbered frame in the affected area will play throughout the entire region. Freeze Frame has an enabled option which can be keyframed. Regions of a freeze frame effect which are enabled, repeat the lowest numbered frame since the last keyframe. This has unique possibilities.
1331
1332 \begin{itemize}
1333     \item If a freeze frame effect has a keyframe in the middle of it set to enabled, the frame in the middle is repeated in the entire effect.
1334     \item If a freeze frame effect has several keyframes, each set to enabled, every time a keyframe is encountered the frame under it becomes the frozen one.
1335     \item If a freeze frame effect alternates between enabled and disabled, each time an enabled keyframe is encountered the frame under it is replicated until the next disabled keyframe. The disabled regions play through.
1336 \end{itemize}
1337
1338 \subsection{Gamma}%
1339 \label{sub:gamma}
1340
1341 \textit{Raw}/\textit{Log} camera images store colors in a $logarithmic$ scale. The blacks in these images are nearly $0$ and the whites are supposed to be infinity. The graphics card and most video codecs store colors in a $linear$ scale but Cinelerra keeps raw/log camera images in their original logarithmic scale when it renders them. This is necessary because the raw image parser can not always decode the proper gamma ($\gamma$) values for the images. It also does its processing in $16\,bit$ integers, which takes away a lot of information.
1342
1343 Mathematically, the gamma function is exponential ($output = input^{\gamma}$) and therefore the inverse of the logarithmic function [$output = \log(input)$]. Actually the formula used by the Cinelerra-gg plugin is: $output = input^{\frac{1}{\gamma}}$ which allows for a range of values $0 \div 1.0$. The gamma effect converts the logarithmic colors to linear colors through a \textit{gamma value} and a \textit{maximum value}. The gamma value determines how steep the output curve is (i.e. the value of the gamma parameter; for color space Rec709 is $2.4$ ($\frac{1}{\gamma} =0.41\dots$), for sRGB is $2.2$ ($\frac{1}{\gamma} =0.45\dots$), etc.). The maximum value is where $1.0$ in the output corresponds to maximum brightness in the input. It serves to avoid clipped values because it allows you to set the maximum value of the output, $1.0$, whenever range adjustment is done (see figure~\ref{fig:gamma01}). It is important to adjust the two parameters accurately in order to avoid undesired and unexpected effects, such as excessive values, unbalanced image, incorrect linearization, etc.
1344
1345 \begin{figure}[htpb]
1346     \centering
1347     \includegraphics[width=0.8\linewidth]{images/gamma01.png}
1348     \caption{settting \textit{Maximun} to $0.5900$}
1349     \label{fig:gamma01}
1350 \end{figure}
1351
1352 The gamma effect has two more parameters to simplify gamma correction. The automatic option causes it to calculate max from the histogram of the image. Use this when making a preview of a long list of images since it changes for every image. The use color picker option uses the value currently in the color picker to set the maximum value. Note that every time you pick a color from the compositor window, you need to click on use color picker to apply the new value.
1353
1354 The best use of the gamma is manually monitoring the waveform as shown in figure~\ref{fig:gamma02}.
1355
1356 \begin{itemize}
1357     \item Look at the highest peak on the \textit{waveform} and measure it with the crosshair observing the numerical value at the top left.
1358     \item Set this value with the \textit{maximum} slider.
1359     \item Then adjust the slider of the \textit{gamma} to our liking, always checking the result on the waveform so to be sure never to exceed the values of clipping, $0 \div 1.0$.
1360 \end{itemize}
1361
1362 \begin{figure}[htpb]
1363     \centering
1364     \includegraphics[width=0.8\linewidth]{images/gamma02.png}
1365     \caption{Setting \textit{Maximun} to $0.6100$ and \textit{Gamma} to $0.3300$}
1366     \label{fig:gamma02}
1367 \end{figure}
1368
1369 Care must be taken when using gamma correction: if the image carries a specific gamma value, or if it has already been corrected previously (for example automatically in the camera), etc.; then a second application of the gamma leads to excessive and artificial results. Gamma is keyframable.
1370
1371 \subsection{Gradient}%
1372 \label{sub:gradient}
1373
1374 The \texttt{gradient} effect overlays a smooth color gradient on top of every video frame. It is useful for all sorts of background fills, for partially filtering, adding depth to the image, or for adding moving highlights. The Gradient effect can generate linear or circular color fills / shape. For linear fills, you can choose the \texttt{angle}, for circular fills the \texttt{center $(X,Y)$} of the created gradient pattern. You can control the \texttt{slope} of the color transition by selecting a transition function ($linear$, $logarithmic$, $squared$) and by changing the start (\texttt{inner}) and stop (\texttt{outer}) radius. Note that both colors used in this color transition can contain an arbitrary \texttt{Alpha} value (transparency). All parameters can be keyed and will be interpolated between keyframes.
1375
1376 The first time you use the plugin it may seem complicated, but if you understand that we have to adjust the gradient from an inner spot we choose to an outer spot we also choose, the work will become easy and fast.
1377
1378 \subsubsection*{Use case (Vignette)}
1379 \label{ssub:use_case_vignette}
1380
1381 \begin{enumerate}
1382     \item Setting the shape to radial
1383     \item Setting the rate to Linear (or Log or Square)
1384     \item Position $X$ and $Y$ to center the main figure.
1385     \item Choose inner color=black
1386     \item Adjust inner radius
1387     \item Bring the inner color alpha slider to $0$
1388     \item Choose outer color=black
1389     \item Check that the outer color alpha slider is $1$.
1390     \item Adjust outer radius
1391 \end{enumerate}
1392
1393 \textit{Note:} The inner and outer colors are visibly mixed in the gradient area. If you want to make a vignetting of only black, you must set the two colors to black and then make the inner one transparent so that it does not cover the figure.
1394
1395 \subsection{HistEq}%
1396 \label{sub:histeq}
1397
1398 Remap colors using blended histogram weights. Figure~\ref{fig:histeq} shows the GUI and the results in a split screen.
1399
1400 \begin{figure}[htpb]
1401     \centering
1402     \includegraphics[width=0.8\linewidth]{images/histeq.png}
1403     \caption{Control window and split screen}
1404     \label{fig:histeq}
1405 \end{figure}
1406
1407 Histeq equalizes the colorspace through use of a \textit{histogram equalization algorithm} --- a technique for adjusting image intensities to enhance contrast. Parameters are:
1408
1409 \begin{description}
1410     \item[Gain:] when set to $1$, the colorspace is best effort. If the gain is set to $0$, the result is the entire regression line of the color map.
1411     \item[Blend:] goes between a straight and a twisted line.
1412     \item[Split output:] diagonally shows in the compositor, the new results on the left and old on the right.
1413     \item[Plot bins/lut:] displays a plot of the result.
1414 \end{description}
1415
1416 \subsection{Histogram}%
1417 \label{sub:histogram}
1418
1419 The histogram allows an immediate view of the contrast amplitude of an image with its distribution of \textit{luma} and \textit{colors} values. If the columns of values occupy the whole range $0-100\%$ then we have maximum contrast; if the range is smaller the contrast is smaller. If most of the values are on the right of the histogram you have an image with highlights at the limit with values clamped to $1.0$. This is called \textit{overexposure}. However, if most of the values are moved to the left, with the limit of the values clamped to $0$, we have a lowlight image and we talk about \textit{underexposure}. Histogram is keyframble (figure~\ref{fig:histogram}).
1420
1421 \begin{figure}[htpb]
1422     \centering
1423     \includegraphics[width=0.8\linewidth]{images/histogram.png}
1424     \caption{Master Histogram and RGB Histogram}
1425     \label{fig:histogram}
1426 \end{figure} 
1427
1428 The Histogram is always performed in floating point RGB regardless of the project color space. The histogram has two sets of transfer parameters: the \textit{input transfer} and the \textit{output transfer}. The input transfer has value on the horizontal axis of $x$; it is a scale of values ranging from $0 to 255$ in the case of an $8\,bit$ image, or it can have normalized values in the range ($0-1.0$) or even be a scale in percentage ($0-100\%$). In the output transfer (the $y\,axis$) is represented the number of times (that is, $y$) a given value $x$ appears. A higher column ($y$ greater) indicates that many pixels have the corresponding value $x$; a lower column indicates that fewer pixels have that value. On the left we have the minimum value $0$, which is the black point. On the right we have the maximum value $1.0$ which is the white point. The intermediate values pass smoothly from one extreme to the other. The three important points (including the midtones, i.e. the Master Offset) are indicated by cursors (small triangles) at the base of the histogram. You can adjust them to change the values of the three points if you want.
1429
1430 There are 4 possible histograms in the histogram viewer. The red, green, blue histograms show the input histograms for red, green, blue and multiply them by an input transfer to get the output red, green, blue. Then the output red, green, blue is scaled by an output transfer. The scaled red, green, blue is converted into a value and plotted on the value histogram. The value histogram thus changes depending on the settings for red, green, blue. The value transfers are applied uniformly to R, G, B after their color transfers are applied. Mathematically, it is said that the values of $x$ are linked to the values of $y$ by a transfer function. This function is represented by a line that leaves the values of $x$ and $y$ unchanged, but we can intervene by modifying this line with the cursors. 
1431
1432 You need to select which transfer to view by selecting one of the channels on the top of the histogram. You can also choose whether to display the master, i.e. only the values of the \textit{luma}, or show the \textit{Parade}, i.e. the three RGB channels. You can switch from one to the other with the two buttons in the upper right corner. The input transfer is defined by a graph overlaid on the histogram; this is a straight line. Video entering the histogram is first plotted on the histogram plot, then it is translated so output values now equal the output values for each input value on the input graph.
1433
1434 After the input transfer, the image is processed by the output transfer. The output transfer is simply a minimum and maximum to scale the input colors to. Input values of $100\%$ are scaled down to the output's maximum. Input values of $0\%$ are scaled up to the output minimum. Input values below $0$ are always clamped to $0$ and input values above $100\%$ are always clamped to $100\%$. Click and drag on the output gradient's triangles to change it. It also has textboxes to enter values into.
1435
1436 Enable the \texttt{Automatic} toggle to have the histogram calculate an automatic input transfer for the red, green, and blue but not the value. It does this by scaling the middle $99\%$ of the pixels to take $100\%$ of the histogram width. The number of pixels permitted to pass through is set by the \texttt{Threshold} textbox. A threshold of $0.99$ scales the input so $99\%$ of the pixels pass through. Smaller thresholds permit fewer pixels to pass through and make the output look more contrasty.
1437 \texttt{Plot histogram} is a checkbox that enables plotting the histogram.
1438 \texttt{Split output} is a checkbox that enables a diagonal split showing in the compositor. 
1439 \texttt{Reset} returns the four curves to their initial state (neutral) as well as the Value/RGB histogram buttons.
1440
1441 \subsection{Histogram Bezier / Curves}%
1442 \label{sub:histogram_bezier_curves}
1443
1444 Histogram Bézier allows an immediate view of the contrast amplitude of an image with its distribution of luma and colors values using a piecewise linear method. In addition it uses a Bézier curve (parametric) on the histogram plot. When mapping color spaces, it has a variety of presentations to get smoother transitions and more pleasing output. It uses more general remapping, not just straight lines but more contour lines. Curves are perhaps the most powerful and sophisticated tool for color correction. For some repetitive details, see the previous description of the Histogram plugin. Histogram Bézier is keyframable. 
1445
1446 The input graph is edited by adding and removing any number of points. Click and drag anywhere in the input graph to create a point and move it. Click on an existing point to make it active and move it. The active point is always indicated by being filled in. The active point's input X and output Y values are given in textboxes on top of the window. The input and output color of the point can be changed through these textboxes. Points can be deleted by first selecting a point and then dragging it to the other side of an adjacent point. They can also be deleted by selecting them and hitting delete (figure~\ref{fig:bezier}).
1447
1448 \begin{figure}[htpb]
1449     \centering
1450     \includegraphics[width=0.8\linewidth]{images/bezier.png}
1451     \caption{Master Histogram and RGB Histogram}
1452     \label{fig:bezier}
1453 \end{figure}
1454
1455 \begin{itemize}
1456     \item \textit{Master} (value) and \textit{R}, \textit{G}, \textit{B} histograms.
1457     \item Textbox for input $x$ (\textit{input}) and input $y$ (\textit{output}).
1458     \item \textit{Output min} and \textit{output max}: sets black or white points. If you use both points it works as Master/Color
1459     Offset. Values can also be less than $0$ and greater than $1.0$.
1460     \item Scale for \textit{contrast range}: sets with cursors shown as little triangles.
1461     \item \textit{Automatic} and \textit{Threshold}: enable the Automatic toggle to have the histogram calculate an automatic input transfer for the red, green, and blue but not the value. It does this by scaling the middle $99\%$ of the pixels to take $100\%$ of the histogram width. The number of pixels permitted to pass through is set by the Threshold textbox. A threshold of $0.99$ scales the input so $99\%$ of the pixels pass through. Smaller thresholds permit fewer pixels to pass through and make the output look more contrasty.
1462     \item \textit{Reset:} returns the four curves to their initial state (neutral).
1463     \item \textit{Split picture:} a checkbox that enables a diagonal split showing in the compositor.
1464     \item \textit{Interpolation:} type of algorithm for the parametric curves; linear, polynomial and Bezier.
1465 \end{itemize}
1466
1467 Curves are used by introducing \textit{control points} simply with the left mouse button and adjusting the value by dragging and dropping. If you drag along the horizontal line only, you change the value of $x$ and you can read this value in the input $x$ textbox. If you drag along the vertical line only, you change the value of $y$ and you can read the value in the input $y$ textbox. This is the output value. The newly clicked control point becomes active and is full green in color. To delete a point we have to make it active and then press the \texttt{Del} key, or we can drag the point beyond the position of another control point to its right or left or, finally, pressing \texttt{RMB}. The control points corresponding to the black point and the white point are automatically created from the beginning, to fix their values and prevent clipping.
1468
1469 Curves are generally adjusted by introducing several control points, some to be kept fixed (as anchors) to prevent curve modification beyond them, and others to be dragged to make the desired correction. The power of the curves lies in being able to circumscribe a small interval at will and intervene only on this without involving the remaining parts of the frame. The precision with which you can work is such that you can almost arrive at a secondary color correction.
1470
1471 \begin{figure}[htpb]
1472     \centering
1473     \includegraphics[width=0.75\linewidth]{images/ex-bezier.png}
1474     \caption{Gain Up/Down; clamp; S-Shaped curve and Luma Key}
1475     \label{fig:ex-bezier}
1476 \end{figure}
1477
1478
1479 The most used type of modification is to create a \textit{S curve}. There can be a lot of shapes that use the S curve; the simplest is to create a control point in the shadows, one in the midtones (anchors) and one in the highlights. Moving the highlight point upwards and the shadow point downwards increases the contrast, making the image sharper and improving the color rendering. With the type of \textit{linear} curve you can make hard adjustments, similar to the result of the use of \texttt{Color 3 Way}, even if this acts on the color wheel (Hue) while the curves act on individual RGB channels.
1480
1481 The \textit{Polynomial} and \textit{Bézier} types introduce \textit{control handles} that allow for more sophisticated and smoother adjustments. The quality of the result is much better, but they require more experience for their optimal use. Extending the handles away from the control point increases the \textit{radius} of the curve at that point. By varying the angle of the handles we change the \textit{tangent} and thus the curvature of the curve below. The difference between Polynomial and Bézier lies in the underlying mathematics, but for practical purposes the use is similar.
1482
1483 Some examples of the use of curves to demonstrate the variety of possible interventions (figure~\ref{fig:ex-bezier}):
1484
1485 \begin{itemize}
1486     \item Scale the image values by increasing the white point or decreasing the white point (gain up and gain down). 
1487         You can decide the scaling value with the formula: $(Input \div Output) = Scale Factor$
1488     \item Limit a value beyond a certain point of brightness (clamp to the value $0.587$ in the figure).
1489     \item S-shaped curve to increase contrast without changing the black and white point (i.e. without \textit{clipping}).
1490     \item Make a real \textit{Luma Key} by bringing a certain value of gray to $100\%$ (white) and lowering everything else to $0\%$ (black). The slope of the two sides indicates how much we want to fade the edges of the matte obtained.
1491 \end{itemize}
1492
1493 \subsection{HolographicTV}%
1494 \label{sub:holographictv}
1495
1496 Incoming objects are projected like holovision seen in the movie Stars Wars as in R2-D2's video message projector of the Princess Leia. You need a movie or background image and above it a track containing the figure on which to apply the effect. This must have a transparent background. There are no configuration parameters; it only has to be applied to the upper track (figure~\ref{fig:holographictv}). 
1497
1498 This effect originated from \url{https://effectv.com}.
1499
1500 \begin{figure}[htpb]
1501     \centering
1502     \includegraphics[width=0.8\linewidth]{images/holographictv.png}
1503     \caption{Holographic messages in CinGG!}
1504     \label{fig:holographictv}
1505 \end{figure}
1506
1507 \subsection{Hue saturation}%
1508 \label{sub:hue_saturation}
1509
1510 With this effect you can change hue, saturation and value. The parameters are modified using 3 simple sliders. The \texttt{hue} control shifts the colors circularly in the color plane, normally resulting in false colors. The \texttt{saturation} control can be used to reduce color footage to black and white. The \texttt{value} control makes any given colors more bright or more subdued.
1511
1512 \subsection{Interpolate Bayer}%
1513 \label{sub:interpolate_bayer}
1514
1515 Uses a Bayer filter algorithm to interpolate (estimate) missing color information. This is needed for some cameras where each pixel location only has an R or G or B value instead of all R, G, and B values for each location. The algorithm creates values for each of the three colors at every location by smearing (interpolating) each set of partial R, G and B values to create values at every pixel location.
1516
1517 \subsection{Interpolate Video}%
1518 \label{sub:interpolate_video}
1519
1520 \subsubsection*{Theory}
1521 \label{ssub:theory}
1522
1523 Each video has its own framerate. If we want to change it (for \textit{timelapse} or \textit{slowmotion}) the best thing is to shoot the scene with suitable framerate. But even in post production we can do something. The simplest method is to remove some frames to speed up the movie or add some to slow it down (from now on, for simplicity we will consider only the timelapse). Needless to say, the result is not smooth and the viewer will notice it immediately. A better method is to use the interpolation, mediating the pairs of frames that alternate. For example, if we have a sequence of frames $1, 2, 3, 4, 5, 6, 7, 8\dots$ we can make a timelapse mixing frames $1$ and $2$, $3$ and $4$, $5$ and $6$, $7$ and $8$ and so on. So we will have a new sequence of $4$ frames instead of the initial $8$: $\underline{12, 34, 56, 78}\dots$ We will get $50\%$ acceleration but it will always be of bad quality because of the too rough blending between the pairs of frames. Blending can be improved by weighing it differently by $50\% frame 1 + 50\% frame 2$, but the result is still unsatisfactory. Further improvements can be achieved by using $logarithmic$ or $exponential$ interpolation instead of $linear$ interpolation. But the most sophisticated methods that lead to better results are based on \textit{optical flow analysis}. These analyses the movement of circumscribed areas over a given period of time. With this method the intermediate frames do not derive from an approximate blending, but from the calculation of the \textit{vector} of the motion between two frames that determines the displacement (\textit{warping}) of the moving figure in the new intermediate frame. \texttt{Interpolate Video} works this way.
1524
1525 \subsubsection*{Practice}
1526 \label{ssub:practice}
1527
1528 The practical use of \texttt{Interpolate Video} is a little different than the theory. The interpolate effect tries to create the illusion of a higher frame rate from source footage of very low framerates by averaging frames over time. It averages two input frames for each output frame. You choose a zone to be evaluated (\texttt{macroblock size}) and a radius (\texttt{search radius}) where you can search for this macroblock in the following frames. The \texttt{Use optic flow} button is activated and playback starts. The plugin will calculate the motion vector (which can be made visible by the \texttt{draw motion vectors} button) and apply it to intermediate frames. This operation is CPU intensive. Once the analysis is done, we can scroll the video by unchecking the two buttons and obtaining the desired result. There are two ways of specifying the input frames. You can specify an input frame rate which is lower than the project frame rate (\texttt{imput frames per seconds}). This causes input frames to be taken at even intervals. You can also specify keyframe locations as the positions of the input frames (\texttt{use keyframes as input}). In this mode the output frame rate is used as the input frame rate and you just create keyframes wherever you want to specify an input frame.
1529
1530 \subsection{Inverse Telecine}%
1531 \label{sub:inverse_telecine}
1532
1533 This is the most effective deinterlacing tool when the footage is a video transfer of a film. This can be used to solve the problem, i.e., undo the damage caused by making film into a TV broadcast. 
1534 That process came about because film is at 24\,\emph{fps} while TV is at 29.97\,\emph{fps} and fields are at 60. 
1535 So the film was converted from 24\,\emph{fps} to 60\,\emph{fps}. 
1536 Roughly speaking, converting every 4 frames into 5 frames plus a slight slow down in speed. 
1537 Then the 60\,\emph{fps} was down-sampled to 30\,\emph{fps} by extracting odd and even lines and interlacing the lines. 
1538 This process is referred to as \textit{three-two pull down} ($3:2$ pull down) in filmmaking and television production for the post production process of transferring film to video.
1539 The three-two pull down is where the telecine adds a third video field (a half frame) to every second video frame, but the untrained eye cannot see the addition of this extra video field.
1540 The \texttt{IVTC} effect is primarily a way to convert \textit{interlaced} video to \textit{progressive} video. 
1541 It reverses the effect of three patterns of interlacing. In the next lines \texttt{A}, \texttt{B}, and \texttt{C} represent fields.
1542
1543 \texttt{A AB BC CD D}
1544  
1545 \texttt{AB CD CD DE EF} 
1546
1547 \texttt{Automatic}
1548
1549 The first two options are fixed patterns and affected by the pattern \textit{offset} and \textit{odd field first} parameters. The last option creates several combinations of lines for each frame and picks the most progressive combination. It is a brute force algorithm that is trying to resample the lines. This technique does not rely on a pattern like other techniques and is less destructive but the timing is going to be jittery because of the lack of a frame rate reduction. In order to smooth out the timing, you need to follow \texttt{inverse telecine} with a \texttt{decimate} effect.
1550
1551 \subsection{Invert Video}%
1552 \label{sub:invert_video}
1553
1554 Invert video is a method of reversing the colors of a video track. The four parameters refer to channels - \texttt{Red}, \texttt{Blue}, \texttt{Green}, \texttt{Alpha}. A very common use is to invert the alpha channel to change transparency.
1555
1556 \subsection{Lens}%
1557 \label{sub:lens}
1558
1559 Create the effect of looking through a lens.
1560
1561 \begin{description}
1562     \item[R, G, B, A Field of View:] quantity of deformation of the relative fields. Often used with \texttt{Lock} to simultaneously affect the 4 fields.
1563     \item[Aspect Ratio:] determines the aspect ratio that you intentionally set.
1564     \item[Radius:] radius of curvature of the distortion. At minimum, it is a sphere (\textit{fish eye}) and at maximum, it is a rectangle (no distortion).
1565     \item[Center X, Y:] determines the coordinates of the center of the sphere. It can be made visible with \texttt{Draw Center}.
1566     \item[Mode:] determines the type of distortion. The choice is between \textit{sphere shrink}, \textit{sphere stretch}, \textit{rectilinear shrink} and \textit{rectlinear stretch}.
1567     \item[Interpolation] determines the interpolation algorithm; from the fastest and least precise \textit{Nearest}, passing through \textit{BiLinear} to the better \textit{BiCubic}.
1568 \end{description}
1569
1570 \subsection{Linear Blur}%
1571 \label{sub:linear_blur}
1572
1573 This effect acts only in one direction which can vary up to an angle of $180°$ with these parameters:
1574
1575 \begin{description}
1576     \item[Lenght:] distance between original image and final blur step; corresponds to the distance of the fields.
1577     \item[Angle:] angle of motion in one direction for linear blur
1578     \item[Steps:] number of blur steps to be used in the calculation. Increasing the number takes more CPU.
1579     \item[Channels:] R,G,B,A.
1580 \end{description}
1581
1582 Figure~\ref{fig:linear} shown here has the parameters: $Length=19$, $Angle=25$, and $Steps=2$.
1583
1584 \begin{figure}[htpb]
1585     \centering
1586     \includegraphics[width=0.8\linewidth]{images/linear.png}
1587     \caption{For clarity of presentation only 2 fields are shown}
1588     \label{fig:linear}
1589 \end{figure}
1590
1591 \subsection{Live Video}%
1592 \label{sub:live_video}
1593
1594 This effect reads video directly from the capture card input. It replaces any video on the track so it is normally applied to an empty track. Only one \texttt{Live Video} effect can exist at any time on the timeline. It can not be shared by more than one track. The configuration for the capture card is taken from the recording preferences. Go to \texttt{Settings$\rightarrow$ Preferences$\rightarrow$ Recording} to set up the capture card.
1595
1596 In the \texttt{Video In} section where it says \texttt{Record driver}, it should be set to either \textit{Video4Linux2} or \textit{IEC 61883}. Other video drivers have not been tested with Live Video and probably will not work. For live video, the selection for \textit{File} Format and \textit{Video} needs to be set to a format the timeline can use. The file format must be \texttt{Quicktime} for Linux and video recording must be enabled for it. Click on the wrench to set the video compression.
1597
1598 The video compression depends on the recording driver. For the \textit{Video4Linux2} recording driver, the compression must be \textit{Motion JPEG A}. For the \textit{IEC 61883} driver, the compression must be \textit{DV}. This gets the driver to generate output in a color model that the timeline can use. Some cards provide color and channel settings. Live video takes the color settings from the values set in the Video In window. Go to \texttt{File$\rightarrow$ Record} to bring up the recording interface and the Video In window. Values set in the Video in window are used by Live Video. Any channels the capture card supports need to be configured in the Video In interface since the same channels are used by the Live Video effect.
1599
1600 With the video recording configured, highlight a horizontal region of a video track or define in and out points. Then drop the Live Video effect into it. Drop other effects after Live Video to process the live video in realtime. For best results, you should use OpenGL and a video card which supports GL shading language. Go to \texttt{Settings$\rightarrow$ Preferences$\rightarrow$ Playback$\rightarrow$ Video Out} to enable the OpenGL driver.
1601
1602 \subsection{Loop video}%
1603 \label{sub:loop_video}
1604
1605 Sections of video can be looped by dropping a loop effect on them. Contrary to the \texttt{settings$\rightarrow$ loop playback} option, the loop effects can be rendered where the \texttt{settings$\rightarrow$ loop playback} option can not be. The loop effects are also convenient for short regions.
1606
1607 The loop effects have one option: the \texttt{number of frames} or \texttt{samples} to loop. This specifies the length of the region to loop starting from either the beginning of the effect or the latest keyframe. The region is replicated for the entire effect.
1608
1609 Every time a keyframe is set in a loop effect, the keyframe becomes the beginning of the region to loop. Setting several keyframes in succession causes several regions to loop. Setting a single keyframe causes the region after the keyframe to be looped throughout the effect, no matter where the keyframe is. The end of an effect can be looped from the beginning by setting the keyframe near the end.
1610
1611 \subsection{Motion51}%
1612 \label{sub:motion51}
1613
1614 This plugin compensates for unwanted motion and stabilizes the picture. The \texttt{Motion51} Plugin simplifies motion stabilization so that without a lot of tweaking you can easily achieve reasonable results, either by using the defaults or varying a single parameter. Since the motion in every clip is specific, there are some additional parameters useful to adjust the settings accordingly. Alternatively, the \texttt{MotionCV} and \texttt{MotionHV} plugins can still be used as the originals, if more control over specific parameters is needed. The Motion51 plugin uses different methods for tracking than the other motion plugins. Motion Stabilization is very useful if you have jittery video, for example when taken from a car window, or while walking.
1615
1616 The better results require more samples. Setting the \texttt{sample set size} is probably the most important setup change. Also, when computing motion compensation, the entire history of the image motion is important, and so it is desirable to enable the playback setting \texttt{play every frame} in order to get good results. When every frame has to be processed, it can be time-consuming. Reasonable results are possible with small sample sets. After setup, the sample size can be increased to produce a high quality rendered result.
1617
1618 \subsubsection*{Description of what the program is doing}
1619 \label{ssub:description_program_doing}
1620
1621 The motion is detected by \textit{sampling} the video image in a circular field. This size and placement of the sample region defaults to most of the image area. When the \texttt{draw vectors} feature is enabled, the outer line trace encloses the searched region. The dotted circles define the target pixel set as the reference sample. The image is sampled using the circle pattern in a grid search. The best match is used to find the center and amount of rotation to transform the current image so that the reference area motion is canceled.
1622
1623 The amount of sampling does not significantly change for smaller or larger search areas. This means that a wide area can be searched just as easily as smaller areas. The main parameter which determines how hard it looks at the image is the \texttt{samples} parameter. It represents the number of possible rotations, as well as the search precision. More samples mean more precision, and less jitter, but the program will run more slowly (figure~\ref{fig:motion51}).
1624
1625 \begin{figure}[htpb]
1626     \centering
1627     \includegraphics[width=0.8\linewidth]{images/motion51.png}
1628     \caption{Motion51 plugin window with its default options set.}
1629     \label{fig:motion51}
1630 \end{figure}
1631
1632 The Samples box at the top is most often the only parameter that you may want to vary.
1633
1634 \subsubsection*{Program Parameters Description follows}
1635 \label{ssub:program_parameters_description}
1636
1637 \begin{description}
1638     \item[X11-OpenGL:] setting can speed up the computation significantly in some cases when hardware OpenGL is available.
1639     \item[Samples:] is the number of pixels which the software will examine to stabilize the picture. The sample set is arranged in 4 equal concentric circular sets. Each sample dot represents content and position for a pattern matching test. Setting the samples to larger values improves the match by adding lots of placement possibilities. The samples/pixels that will be utilized are distributed throughout the selected area --- this is seen within the circles drawn when Draw Vectors is enabled. See figure~\ref{fig:motion51}.
1640     \item[Draw vectors:] demonstrates the search operation of motion stabilization. When enabled, the outer search boundary (oval), the search grid area (rectangle), and the reference sample (circles) are visible. 4 concentric circles show the reference sample set (target). You will also see an arrow in the center of the circle which shows each image displacement from frame to frame. When you render the video using the motion plugin, these dots/lines/circles are drawn into the rendered output. Draw vectors helps to visualize the meaning of the parameters to aid in setup. You should disable Draw Vectors before the final rendering.
1641     \item[Sample Radius:] is the radius of a circle that denotes the area of the sample locations. It is expressed as a percentage of the smallest image edge. For example, if it is set to $50\%$, then the circle will overlap about $\frac{1}{2}$ of the image. This does not change the number of samples. It does change the area from where the samples are gathered. If you have Draw vectors on, you can see the faint outline of a circle used for the radius.
1642     \item[Center X/Y:] is the center position of the sample circle, as a percentage of image width and height.
1643     This is useful to reset the reference focal point in cases where the important feature target is off-center.
1644     When both $X$ and $Y$ are set to $50\%$, the samples will be used from around the center of the video.
1645     \item[Search W/H:] determines the width and height of the rectangular area used for the grid pattern search. Samples are taken by moving the center of the circles in a grid pattern.
1646     \item[Horiz/Vert shake limit:] (Shaking refers to image translation) determines translation constraints. If the motion determined by the search exceeds the limit, it is clipped to a value that is at the limit boundary. For example, if the match indicates that the motion is $60\%$ off the reference target, but the limit is $50\%$, then the actual translation used will be limited to only $50\%$.
1647     \item[Shake fade:] determines how fast the translation cancellation fades away, and the image resettles to its actual appearance. Every frame that is processed accumulates the motion of the past. The amount of the past motion which is applied is reduced by the fading factor. The current match is then added to the fading past motion history. Fading works fast. It is applied every frame. So if fade is $10\%$, and no new motion occurs in the input, the history will be $90\%, 81\%, 73\%, 66\%\dots$ and in $30$ frames only $4.2\%$ of the past motion will be present in the effect. Fading insures that the image will eventually settle re-centered when the image motion ends.
1648     \item[Twist limit:] (Twisting refers to image rotation) determines the rotation constraints. If the rotation determined by the search exceeds the limit, it is clipped to the limit boundary. Its operation is similar to the shake limits.
1649     \item[Twist fade:] determines how fast the rotation cancellation fades away, and the image resettles to its actual appearance. Its operation is similar to the shake fade.
1650     \item[Enable Tracking:] caches the search results in a file so that subsequent playback does not have to be recalculated. When tracking is enabled, before a frame is processed the frame number is used to look for cached results. If cache data is available, it is used. If no data is available, the frame is processed by the motion tracking search, and the results are added to the cache file. If tracking is not enabled, the data is always sourced from the motion tracking search and the tracking file is not updated.
1651     \item[Tracking file:] is the name of the file which will contain the calculated values to be saved. Note that the default is \texttt{/tmp/motion51} which can be hazardous, since a system crash or a reboot can delete \texttt{/tmp} files.
1652     \item[Reset Defaults:] button is used to revert to the initial defaults built into the program.
1653     \item[Reset Tracking:] will delete the current Tracking file and disables tracking so that any previously calculated values are no longer available. However, because motion stabilization can often be cpu intensive, if the default file already exists, it will create a file name from the loaded asset.
1654     \item[Play Every Frame:] shows if you are Currently using: Play every frame. For best results, set play every frame. This can be set in \texttt{Settings$\rightarrow$ Preferences$\rightarrow$ Playback A} Tab in the \texttt{Video out} section.
1655 \end{description}
1656
1657 \subsection{Motion}%
1658 \label{sub:motion}
1659
1660 The \texttt{motion tracker} is almost a complete application in itself. The motion tracker tracks two types of motion: \textit{translation} and \textit{rotation}. It can track both simultaneously or one only. It can do $\frac{1}{4}$ pixel tracking or single pixel tracking. It can stabilize motion or cause one track to follow the motion of another track. Although the motion tracker is applied as a realtime effect, it usually must be rendered to see useful results. The effect takes a long time to precisely detect motion so it is very slow.
1661
1662 Motion tracker works by using one region of the frame as the region to track. It compares this region between $2$ frames to calculate the motion. This region can be defined anywhere on the screen. Once the motion between $2$ frames has been calculated, a number of things can be done with that \textit{motion vector}. It can be scaled by a user value and clamped to a maximum range. It can be thrown away or accumulated with all the motion vectors leading up to the current position.
1663
1664 To save time the motion result can be saved for later reuse, recalled from a previous calculation, or discarded. The motion tracker has a notion of $2$ tracks, the \textit{master} layer and the \textit{target} layer. The master layer is where the comparison between $2$ frames takes place. The target layer is where motion is applied either to track or compensate for the motion in the master layer.
1665
1666 Motion tracking parameters:
1667
1668 \begin{description}
1669     \item[Track translation] Enables translation operations. The motion tracker tracks $X$ and $Y$ motion in the master layer and adjusts $X$ and $Y$ motion in the target layer.
1670     
1671     \item[Translation block size] For the translation operations, a block is compared to a number of neighboring blocks to find the one with the least difference. The size of the block to search for is given by this parameter.
1672     \item[Translation search radius] The size of the area to scan for the translation block.
1673     \item[Translation search steps] Ideally the search operation would compare the translation block with every other pixel in the translation search radius. To speed this operation up, a subset of the total positions is searched. Then the search area is narrowed and re-scanned by the same number of search steps until the motion is known to $\frac{1}{4}$ pixel accuracy.
1674     \item[Block X, Y] These coordinates determine the center of the translation block based on percentages of the width and height of the image. The center of the block should be part of the image which is visible at all times.
1675     \item[Maximum absolute offset] The amount of motion detected by the motion tracker is unlimited if this is $100$. If it is under $100$ the amount of motion is limited by that percentage of the image size.
1676     \item[Settling speed] The motion detected between every frame can be accumulated to form an absolute motion vector. If the settling speed is $100$ the absolute vector is added to the next frame. If the settling speed is less than $100$ the absolute vector is downscaled by the settling amount before being added to the next frame.
1677     \item[Track rotation] Enables rotation operations. The motion tracker tracks rotation in the master layer and adjusts rotation in the target layer.
1678     \item[Rotation block size] For rotation operations a single block is compared to equally sized blocks, each rotated by a different amount. This is the size of the rotation block.
1679     \item[Rotation search radius] This is the maximum angle of rotation from the starting frame the rotation scanner can detect. The rotation scan is from this angle counterclockwise to this angle clockwise. Thus the rotation search radius is half the total range scanned.
1680     \item[Rotation search steps] Ideally every possible angle would be tested to get the rotation. To speed up the rotation search, the rotation search radius is divided into a finite number of angles and only those angles compared to the starting frame. Then the search radius is narrowed and an equal number of angles is compared in the smaller radius until the highest possible accuracy is achieved. Normally you need one search step for every degree scanned. Since the rotation scanner scans the rotation search radius in two directions, you need two steps for every degree in the search radius to search the complete range.
1681     \item[Draw vectors] When translation is enabled, $2$ boxes are drawn on the frame. One box represents the translation block. Another box outside the translation block represents the extent of the translation search radius. In the center of these boxes is an arrow showing the translation between the $2$ master frames. When rotation is enabled, a single box the size of the rotation block is drawn rotated by the amount of rotation detected.
1682     \item[Track single frame] When this option is used the motion between a single starting frame and the frame currently under the insertion point is calculated. The starting frame is specified in the Frame number box. The motion calculated this way is taken as the absolute motion vector. The absolute motion vector for each frame replaces the absolute motion vector for the previous frame. Settling speed has no effect on it since it does not contain any previous motion vectors. Playback can start anywhere on the timeline since there is no dependence on previous results.
1683     \item[Track previous frame] Causes only the motion between the previous frame and the current frame to be calculated. This is added to an absolute motion vector to get the new motion from the start of the sequence to the current position. After every frame processed this way, the block position is shifted to always cover the same region of the image. Playback must be started from the start of the motion effect in order to accumulate all the necessary motion vectors.
1684     \item[Previous frame same block] This is useful for stabilizing jerky camcorder footage. In this mode the motion between the previous frame and the current frame is calculated. Instead of adjusting the block position to reflect the new location of the image, like Track Previous Frame does, the block position is unchanged between each frame. Thus a new region is compared for each frame.
1685     \item[Master layer] This determines the track which supplies the starting frame and ending frame for the motion calculation. If it is Bottom the bottom track of all the tracks sharing this effect is the master layer. The top track of all the tracks is the target layer.
1686     \item[Calculation] This determines whether to calculate the motion at all and whether to save it to disk. If it is \textit{Don't Calculate} the motion calculation is skipped. If it is \textit{Recalculate} the motion calculation is performed every time each frame is rendered. If it is \textit{Save} the motion calculation is always performed but a copy is also saved. If it is \textit{Load}, the motion calculation is loaded from a previous save calculation. If there is no previous save calculation on disk, a new motion calculation is performed.
1687     \item[Action] Once the motion vector is known this determines whether to move the target layer opposing the motion vector or following the motion vector. If it is \textit{Do Nothing} the target layer is untouched. If it is \textit{Track\dots} the target layer is moved by the same amount as the master layer. This is useful for matching titles to objects in the frame. If it is \textit{Stabilize\dots} the target layer is moved opposite to the motion vector. This is useful for stabilizing an object in the frame. The motion operations can be accurate to single pixels or subpixels by changing the action setting.
1688 \end{description}
1689
1690 \subsubsection*{Secrets of motion tracking}
1691 \label{ssub:secrets_motion_tracking}
1692
1693 Since it is a very slow effect, there is a method to applying the motion tracker to get the most out of it. First disable playback for the track to do motion tracking on. Then drop the effect on a region of video with some motion to track. Then rewind the insertion point to the start of the region. \texttt{Set Action$\rightarrow$ Do Nothing}; \texttt{Set Calculation$\rightarrow$ Don't calculate}; Enable \texttt{Draw vectors}. Then enable playback of the track to see the motion tracking areas.
1694
1695 Enable which of translation motion or rotation motion vectors you want to track. By watching the compositor window and adjusting the \texttt{Block x,y} settings, center the block on the part of the image you want to track. Then set \texttt{search radius}, \texttt{block size}, and \texttt{block coordinates} for translation and rotation.
1696
1697 Once this is configured, set the calculation to \texttt{Save coords} and do test runs through the sequence to see if the motion tracker works and to save the motion vectors. Next, disable playback for the track, disable \texttt{Draw vectors}, set the motion action to perform on the target layer and change the calculation to \texttt{Load coords}. Finally enable playback for the track.
1698
1699 When using a single starting frame to calculate the motion of a sequence, the starting frame should be a single frame with the least motion to any of the other frames. This is rarely frame $0$. Usually it is a frame near the middle of the sequence. This way the search radius need only reach halfway to the full extent of the motion in the sequence.
1700
1701 If the motion tracker is used on a render farm, Save coords and previous frame mode will not work. The results of the save coords operation are saved to the hard drives on the render nodes, not the master node. Future rendering operations on these nodes will process different frames and read the wrong coordinates from the node filesystems. The fact that render nodes only visualize a portion of the timeline also prevents previous frame from working since it depends on calculating an absolute motion vector starting on frame $0$.
1702
1703 \subsubsection*{2 pass motion tracking}
1704 \label{ssub:2_pass_motion_tracking}
1705
1706 The method described above is \textit{two-pass motion tracking}. One pass is used just to calculate the motion vectors. A second pass is used to apply the motion vectors to the footage. This is faster than a single pass because errors in the motion vector calculation can be discovered quickly. This also allows the motion tracking to use a less demanding colormodel like \textit{RGB888} in the scanning step and a more demanding colormodel like \textit{RGB Float} in the action step. The scanning step takes much longer than action. This has the disadvantage of not being practical for extremely long sequences where some error is acceptable and the picture quality is low to begin with, like stabilizing camcorder footage.
1707
1708 The slower method is to calculate the motion vectors and apply them simultaneously. This method can use one track as the motion vector calculation track and another track as the target track for motion vector actions. This is useful for long sequences where some error is acceptable.
1709
1710 \subsubsection*{Using blur to improve motion tracking}
1711 \label{ssub:blur_improve_motion_tracking}
1712
1713 With extremely noisy or interlaced footage, applying a blur effect before the motion tracking can improve accuracy. Either save the motion vectors in a tracking pass and disable the blur for the action pass or apply the blur just to the master layer.
1714
1715 \subsubsection*{Using histogram to improve motion tracking}
1716 \label{ssub:histogram_improve_motion_tracking}
1717
1718 A histogram is almost always applied before motion tracking to clamp out noise in the darker pixels. Either save the motion vectors in a tracking pass and disable the histogram for the action pass or apply the histogram just to the master layer.
1719
1720 \subsubsection*{Tracking stabilization in action}
1721 \label{ssub:tracking_stabilization_action}
1722
1723 This is an explanation of how to stabilize a video as in the case of a video taken from a vehicle.
1724
1725 First select on the timeline the part of the footage you want to stabilize, using the in and out points. Then apply the motion effect on that part of the video. Select the \texttt{Previous frame same block} option. That option is recommended for stabilizing jerky camcorder footage. Its goal is not to \textit{follow} an object. The block stays exactly at the same place during all the effect length.
1726
1727 Enlarge the block and select almost half the size of the video. Select the \texttt{Stabilize subpixel} option as it will give a finer stabilization. Reduce the \texttt{Maximum absolute offset} value to limit the stabilization amplitude. You probably prefer to get a non-perfect stabilization on some places on the video rather than having a very large black border on one side of the picture during big shakes. Set the \texttt{Translation search steps} value to $128$. Increasing that value will not give a better result and only considerably increases the rendering time. Make sure the \texttt{Draw vectors} option is selected, and render the part of the video where the motion effect is applied.
1728
1729 If the result is good, deselect the \texttt{Draw vectors} option so that the block and vectors are not drawn anymore on the video. Then, render your video to a \texttt{.dv} file, and import it into your project. You will notice the video is stabilized but there are black borders which appear on sides of the frame. You have to \texttt{zoom in} and define projector keyframes to move the projector around the screen, in order to remove those black borders. The more your footage is jerky, the more you have to zoom in to discard the black borders. That is why the result is better with HDV footage than with DV footage.
1730
1731 An interesting side note about \texttt{add offset} usage is explained next\protect\footnote{credit Pierre Marc Dumuid}
1732
1733 To stabilize video, the motion plugin uses a \textit{tracking frame} to which to track to and a region within that frame to track (generally an object in the background) in the current frame.  When the region is obscured, often by something in the foreground or by leaving the screen, then the motion compensation would fail, and the video jumps all over the place.
1734
1735 You set a second region to track, and then \texttt{add offset}.
1736
1737 This shows how it is used.  It works very well:
1738
1739 \begin{verbatim}
1740 ------k-------k-----------------
1741 ^      ^^
1742 A      BC
1743
1744 A - object1 is visible in the background up until C
1745 B - (the frame before C) has both object1 and object2 visible
1746 C - has only object2 visible
1747 \end{verbatim}
1748
1749 \begin{enumerate}
1750     \item Make a keyframe and set to track object1.
1751     \item Make a keyframe at C and track frame at B, set to track object2.
1752     \item Set keyframe at C to add offsets that were calculated at B.
1753 \end{enumerate}
1754
1755 \subsubsection*{Tip}
1756 \label{ssub:tip}
1757
1758 The motion vector is a text file located in \texttt{/tmp}. We can open it with a plain editor and modify the wrong $X\,Y$ coordinates, i.e. those that deviate from the linearity, to correct the errors that always happen when we perform a motion tracking (jumps). It can be a long and tedious job, but it leads to good results.
1759
1760 \subsection{Motion 2 Point}%
1761 \label{sub:motion_2_point}
1762
1763 Motion stabilization using 2 pass tracking.
1764
1765 \subsection{Motion Blur}%
1766 \label{sub:motion_blur}
1767
1768 Uses X/Y camera automation vectors to apply a linear blur trailing camera direction due to movement.
1769 \begin{description}
1770     \item[Length] distance between original image and final blur step; corresponds to the distance of the fields.
1771     \item[Steps] number of blur steps to be used in the calculation. Increasing the number takes more CPU.
1772 \end{description}
1773
1774 \subsection{MotionCV}%
1775 \label{sub:motioncv}
1776
1777 Motion tracking/stabilization from the community version of cinelerra.
1778
1779 \subsection{MotionHV}%
1780 \label{sub:motionhv}
1781
1782 Updated motion tracking/stabilization of 2017 from the original author of cinelerra.
1783
1784 \subsection{Oil painting}%
1785 \label{sub:oil_painting}
1786
1787 This effect makes video tracks appears as a painting. It can be controlled by \texttt{Radius} slider and \texttt{intensity of colors} can be chosen as an option.
1788
1789 \subsection{Overlay}%
1790 \label{sub:overlay}
1791
1792 This effect can combine several tracks by using the so called Overlayer. This is a basic internal device normally used by Cinelerra GG Infinity to create the dissolve transitions and for compositing the final output of every track onto the output bitmap. The Overlayer has the ability to combine one or several image layers on top of a bottom layer. It can do this combining of images in several different (and switchable) output modes such as \textit{Normal}, \textit{Additive}, \textit{Subtractive}, \textit{Multiply} (Filter), \textit{Divide}, \textit{Max} and \textit{Replace}. For a detailed list refer to the chapter on Overlay Modes
1793 \todo{Link to Overlay Modes chapter}
1794 --- PorterDuff.
1795
1796 The \texttt{overlay} plugin enables the use of this Overlayer device in the middle of any plugin stack, opening endless filtering and processing possibilities. It is only useful as a \textit{shared plugin} (i.e. a multitrack plugin). To use the overlay plugin:
1797
1798 \begin{enumerate}
1799     \item Add the effect to Track A.
1800     \item Choose \textit{attach effect} from the context menu of another track (Track B).
1801     \item Choose Track A:Overlay as a shared plugin.
1802     \item Manipulate the plugin parameters in Track A.
1803 \end{enumerate}
1804
1805 \subsection{Perspective}%
1806 \label{sub:perspective}
1807
1808 The \texttt{perspective} plugin allows you to change the perspective of an object and is used to make objects appear as if they are fading into the distance. Basically, you can get a different view. A transformation is used which preserves points, lines, and planes as well as ratios of distances between points lying on a straight line.
1809
1810 In (figure~\ref{fig:perspective}) you can see that there are four options for the endpoints used for the edges.
1811
1812 \begin{figure}[htpb]
1813     \centering
1814     \includegraphics[width=0.4\linewidth]{images/perspective.png}
1815     \caption{perspective control window}
1816     \label{fig:perspective}
1817 \end{figure}
1818
1819 \begin{description}
1820     \item[Default] if OpenGL is being used with your graphics card, this will be the option in effect. If no OpenGL, then it will be Cubic.
1821     \item[Nearest] using software, nearest neighbor can look step-py.
1822     \item[Linear] software implementation of a linear algorithm.
1823     \item[Cubic] smoothest looking on the 
1824     edges and considered the best.
1825 \end{description}
1826
1827 Key Presses for using the Perspective plugin:
1828
1829 \begin{longtable}{l l}
1830     \toprule
1831     Left mouse button & drags the corner that is closest to current location \\
1832     Alt key + left mouse & translates the perspective; drags the whole image \\
1833     Shift key + left mouse & zooms the perspective \\
1834     Alt+Shift + left mouse & translates view but does not change output \\
1835     \bottomrule
1836 \end{longtable}
1837
1838 Note that the red color lines in the box show the composer boundary.
1839
1840 In order to see endpoints that go off the screen, you can use the zoom slider which changes only the zoom view and does nothing else. The slider uses a logarithmic scale ranging from $\frac{1}{100} to 100$. 
1841
1842 Figure~\ref{fig:perspective01} show the results of the 4 different smoothing options.
1843
1844 \begin{figure}[hbtp]
1845     \centering
1846     \includegraphics[width=0.7\linewidth]{images/perspective01.png}
1847     \caption{Clockwise: Nearest; Linear; OpenGL and Cubic}
1848     \label{fig:perspective01}
1849 \end{figure}
1850
1851 \subsection{Polar}%
1852 \label{sub:polar}
1853
1854 The \texttt{Polar} effect bends and warps your video in weird ways. Mathematically, it converts your video from either \textit{polar} coordinates to \textit{rectangular} coordinates, or the reverse.
1855
1856 \subsection{RGB-601}%
1857 \label{sub:rgb-601}
1858
1859 For analog video or MPEG (including DVD) output, the maximum range for R,G,B is $[16,235]$ ($8\,bit$). For YUV, the maximum range for intensity (\textit{Y}) is $[16, 235]$ ($8\,bit$). This range corresponds to gray levels from $6\%$ to $92\%$. When rendering, values outside of these ranges will be clipped to these limits.
1860
1861 To render to MPEG, add the \texttt{RGB-601} effect to all video tracks where material uses the full intensity scale ($0-100\%$), and enable \texttt{RGB$\rightarrow$ 601} compression. Consider adding the \texttt{Videoscope} effect after RGB-601 to see how RGB-601 affects your dynamic range. To preview how your rendered MPEG would look without \texttt{RGB$\rightarrow$ 601} compression, instead enable \texttt{601$\rightarrow$ RGB} expansion and you will observe a noticeable contrast increase. Although RGB-601 will reduce contrast in your video tracks, the contrast will be restored during MPEG playback.
1862
1863 \subsection{RGBShift}%
1864 \label{sub:rgb-shift}
1865
1866 Most cameras take the light coming into the lens, and convert that into $3$ sets of numbers, one for Red (R), one for Green (G), and one for Blue (B). Some of the older cameras were composed of $3$ sensors and originally the RGB sensors were on $3$ separate planes and had to be aligned. If they were misaligned in the video, you can use \texttt{RGBShift} to get them realigned. To move a specific color up/down, modify the \texttt{dy} value using the slider bar in the RGBShift window. To move a color left/right, modify the corresponding \texttt{dx} value. Note that the current values of the RGBShift are maintained in the \texttt{.bcast5} defaults file and will be retained across sessions. If using the YUV color space, you will want to use \texttt{YUVShift} instead. Figure~\ref{fig:rgbshift} showing RGB shift before and after.
1867
1868 \begin{figure}[hbtp]
1869     \centering
1870     \includegraphics[width=0.8\linewidth]{images/rgbshift.png}
1871     \caption{Bad Misaligned color and after color aligned}
1872     \label{fig:rgbshift}
1873 \end{figure}
1874
1875 \subsection{Radial Blur}%
1876 \label{sub:radial_blur}
1877
1878 Radial blur is a \textit{Bokeh} effect that creates a whirlpool which simulates a swirling camera. You can vary the location, type, and quality of the blur.
1879
1880 \begin{description}
1881     \item[X,Y] center of the circle of movement.
1882     \item[Angle] angle of motion in one direction.
1883     \item[Steps] number of blur steps to be used in the calculation; increasing this number uses more CPU.
1884 \end{description}
1885
1886 Figure~\ref{fig:radial} has the parameters: $Angle=-35$ and $Steps=2$.
1887
1888 \begin{figure}[hbtp]
1889     \centering
1890     \includegraphics[width=0.8\linewidth]{images/radial.png}
1891     \caption{For clarity of presentation only 2 fields are shown}
1892     \label{fig:radial}
1893 \end{figure}
1894
1895 \subsection{ReframeRT}%
1896 \label{sub:reframert}
1897
1898 ReframeRT changes the number of frames in a sequence of video directly from the timeline. The faster method for getting the same results as this plugin is to use the \texttt{speed curve} which was a later addition. But if you need very precise results, \texttt{ReframeRT} is most useful. There are two ways to do this, which can be selected from the checkboxes in the configuration GUI. The first \texttt{Stretch} mode changes the number of frames in the sequence, and therefore its length, but not the framerate. The \texttt{Downsample} mode instead keeps the length of the movie by varying the framerate.
1899 It is important to understand that the plugin works by varying the frames, the possible change of \texttt{fps} is only a side effect of the creation of new frames due to interpolation.
1900
1901 \subsubsection*{Stretch}%
1902 \label{ssub:stretch}
1903
1904 Stretch mode multiplies the current frame number of its output by the \textit{scale factor} to arrive at the frame to read from its input. The scaling factor is not entered directly but using a number of \textit{input} frames to be divided by the number of \textit{output} frames.
1905
1906 \vspace{1ex} \texttt{Scale factor = Input frames / Output frames}
1907
1908 \[\frac{1}{8} \Rightarrow scale\, factor = 0.125 \quad (slowmotion)\]
1909
1910 That is, one input frame of the original movie corresponds to $8$ new output frames originated by interpolation. It is the opposite with regard to \textit{fast play}.
1911
1912 The stretch mode has the effect of changing the length of output video by the inverse of the scale factor. If the scale factor is greater than $1$, the output will end before the end of the sequence on the timeline. If it is less than $1$, the output will end after the end of the sequence on the timeline. The ReframeRT effect must be lengthened to the necessary length to accommodate the scale factor. Change the length of the effect by clicking on the endpoint of the effect and dragging.
1913
1914 Although stretch mode changes the number of the frames read from its input, it does not change the framerate of the input. Effects before ReframeRT assume the same frame rate as ReframeRT.
1915 In stretch mode to create a fast play effect enter a value greater than $1$ to get accelerated playback.
1916 For a slow motion effect, use ReframeRT in stretch mode with a value less than $1$.
1917
1918 \textit{Example:} you have a clip that you want to put in slow motion. The clip starts at $33.792\, seconds$ and ends at $39.765$. The clip is $5.973\, seconds$ long. You want to play it at $\frac{4}{10}^{ths}$ normal speed. You divide the clip length by the playback speed ($5.973\div0.4$) to get a final clip length of $14.9325\,seconds$. You create an in point at the start of your clip: $33.792\,seconds$. You put an out point $14.9325\,seconds$ later, at $48.7245\,seconds$ ($33.792 + 14.9325$). You attach a \texttt{ReframeRT} effect, set it to $0.4$ and stretch. You change the out point at $48.7245$ to an in point. You start your next clip after the slow motion effect at the $48.7245$ out point. You can do this without making any calculations by first applying the effect and then lengthening or shortening the bar to where the stretched movie ends.
1919
1920 \subsubsection*{Downsample}%
1921 \label{ssub:downsample}
1922
1923 Downsample mode does not change the length of the output sequence. It multiplies the frame rate of the output by the scale factor to arrive at a frame rate to read the input. This has the effect of replicating the input frames so that they only change at the scaled frame rate when sent to the output. It does not change the length of the sequence. If the scale factor is $0.5$ and the output frame rate is $30 \,fps$, only $15$ frames will be shown per second and the input will be read at $15 \,fps$. Downsample is only useful for scalefactors below $1$, hence the name downsample.
1924
1925 Downsample mode changes the frame rate of the input as well as the number of the frame to read, so effects before ReframeRT see the $frame rate \times scale factor$ as their frame rate. If the scale factor is $2$ and the output frame rate is $30$, the input frame rate will be $60$ and the input frame number will by doubled. This will not normally do anything, but some input effects may behave differently at the higher frame rate.
1926
1927 \subsubsection*{Other important points}%
1928 \label{ssub:other_important_points}
1929
1930 \begin{itemize}
1931     \item ReframeRT uses the fps indicated in \texttt{Settings$\rightarrow$ Format$\rightarrow$ fps} project and not the \texttt{fps} of the assets.
1932     \item It can be associated with Nested Clips.
1933     \item As an alternative to ReframeRt you can use the \textit{speed curve}, or change the framerate in \texttt{Resources$\rightarrow$ info} and in the \texttt{Project}.
1934     \item It is keyframmable.
1935 \end{itemize}
1936
1937 \subsection{Reroute}%
1938 \label{sub:reroute}
1939
1940 The \texttt{Reroute} plugin enables you to selectively transfer the Alpha channel or the Components (RGB or YUV) or both from a \textit{source} track to a \textit{target} track, partially overwriting the target's contents. It works as a \textit{shared plugin}. The typical usage scenario is to build up a possibly animated Mask in one track and then to transfer the Alpha channel to another content track.
1941
1942 \subsection{Reverse video}%
1943 \label{sub:reverse_video}
1944
1945 Media can be reversed on the timeline in realtime. This is not to be confused with using the reverse playback on the transport panel. The \texttt{reverse} effects reverse the region covered by the effect regardless of the transport direction. The region to be reversed is first determined by what part of the track the effect is under and second by the locations of keyframes in the effect. The reverse effects have an enabled option which allows you to set keyframes. This allows many possibilities.
1946
1947 Every enabled keyframe is treated as the start of a new reversed region and the end of a previous reversed region. Several enabled keyframes in succession yield several regions reversed independent of each other. An enabled keyframe followed by a disabled keyframe yields one reversed region followed by a forward region.
1948
1949 \subsection{Rotate}%
1950 \label{sub:rotate}
1951
1952 The \texttt{Rotate} filter can rotate the video in $90$ degree increments or by any number of degrees through use of the \textit{wheel} and about any \textit{pivot point}. It can also reverse and flip the video.
1953
1954 \subsection{Rumbler}%
1955 \label{sub:rumbler}
1956
1957 The \texttt{Rumbler} plugin can be used to create dream-like or earthquake-like noise in the video. It creates noise by jiggling the corners through use of perspective transformation at the corners. The algorithm used is:
1958
1959 \[Rumbler\,(value) = (value\, at\, time) + amplitude \times (random\, generator)\]
1960
1961 The random generator varies from $-0.5\, to\, 0.5$. The rumble perturbs the normal values at time points which occur rate times a second. The values used between the rumble points are interpolated, so that the value jiggles rate times a second, by as much as the rumble amplitude. The time unit is frames per second. The corners are in units of percent width/height (figure~\ref{fig:rumbler}).
1962
1963 \begin{figure}[hbtp]
1964     \centering
1965     \includegraphics[width=0.6\linewidth]{images/rumbler.png}
1966     \caption{Rumbler control window}
1967     \label{fig:rumbler}
1968 \end{figure}
1969
1970 Screencast shows:
1971
1972 \textit{Time jittering} - $20\, fps$ 1 time a second.
1973 \textit{Corners jittering} - $25\%$  $5$ times a second.
1974 Using \textit{random seed} $0$ for a rumble sequence.
1975
1976 Plugin variables:
1977
1978 \begin{description}
1979     \item[Rumbler:] gain applied to random rumbler.
1980     \item[Rate:] number of times per second.
1981     \item[Time:] number of frames per rate times a second; if 0 has no effect on results.
1982     \item[Space:] corners jiggling in percentage per rate times a second; if 0 has no effect on results.
1983     \item[Seq:] is a random seed number; any reasonable positive or negative number you choose.
1984 \end{description}
1985
1986 \subsection{SVG via Inkscape}%
1987 \label{sub:svg_via_inkscape}
1988
1989 This plugin allows the user to manipulate an SVG (scalable vector graphics) image with \textit{Inkscape} without having to leave the program. The associated cinelerra window provides the ability to change the DPI, the Out $x/y$ coordinates, and the Out w/h values. For more information on use of inkscape, refer to: \url{https://inkscape.org/develop/about-svg/}
1990
1991 \begin{description}
1992     \item[DPI] is Dots per inch and it represents the resolution of the SVG image. Since the image is scaled with interpolation mode linear, the edges will look blurry when the input resolution is lower than the output resolution. You can either set the desired \texttt{DPI value} in the window or use the tumbler on the integer text box, then use the \texttt{update dpi} button to have the change take effect. Changing DPI causes the entire image to be re-exported via inkscape. DPI changes cause adjustments in the resolution, speed of re-import, and storage needed for the image data.
1993     \item[Out\_x/Out\_y] allow for changing the location of the SVG via the $x$ or $y$ coordinates.
1994     \item[Out\_w/Out\_h]  The scaling is controlled by width and height as they are normal parameters to overlay.
1995 \end{description}
1996
1997 Figure~\ref{fig:svg} shows the menu options plugin window and the SVG image in the Inkscape window.
1998
1999 \begin{figure}[hbtp]
2000     \centering
2001     \includegraphics[width=0.8\linewidth]{images/svg.png}
2002     \caption{Control window and Inkscape}
2003     \label{fig:svg}
2004 \end{figure}
2005
2006 \subsection{Scale}%
2007 \label{sub:scale}
2008
2009 Reduce or expand the image size depending on the ratio.
2010
2011 \begin{description}
2012     \item[Size] Height and Width in pixel; plus pulldown menu with preset.
2013     \item[Scale] Aspect ratio
2014     \item[Constrain ratio] Lock height to width rate
2015 \end{description}
2016
2017 \subsection{Scale Ratio}%
2018 \label{sub:scale_ratio}
2019
2020 With the Scale Ratio plugin you can manipulate your video to maintain the pixel aspect ratio (proportional geometry), possibly for a different output Display device (figure~\ref{fig:scaleratio}).
2021
2022 \begin{figure}[hbtp]
2023     \centering
2024     \includegraphics[width=0.6\linewidth]{images/scaleratio.png}
2025     \caption{Many parameters of scale ratio}
2026     \label{fig:scaleratio}
2027 \end{figure}
2028
2029 \texttt{In R} and \texttt{Out R} representing the current input and output aspect ratios. Use the arrows to change to your desired values. Next you have the \texttt{In W/H} and the \texttt{Out W/H} for Width and Height. In the middle of the plugin on the right-hand side, you can set the Scale type of \textit{None}, \textit{Scaled}, \textit{Cropped}, \textit{Filled}, \textit{Horiz edge} and \textit{Vert edge}. The top part (aspect ratio data) is used to compute the bottom part when the \texttt{Apply} button is pressed. The bottom part allows you to reposition the image input or output to customize the results. When the in/out aspect ratios are different, the output must be cropped or filled to fit the output and maintain pixel square appearance. Left and right sides of the bottom portion show the \texttt{Source} and the \texttt{Destination X, Y, W, H} values. As you change the values on the left side, you can see how this will affect the output as you observe the results in the compositor window. For example, as you change the values for \texttt{SrcY} in a \texttt{cropped} Scale scenario, you see up/down movement.
2030
2031 \subsection{Selective Temporal Averaging}%
2032 \label{sub:selective_temporal_averaging}
2033
2034 This plugin is designed to smooth out non-moving areas of a video clip (figure~\ref{fig:staveraging}).
2035 \vspace{2ex}
2036 \begin{wrapfigure}[22]{O}{0.4\linewidth} 
2037     \vspace{-4ex}
2038     \includegraphics[width=0.9\linewidth]{images/staveraging.png}
2039     \caption{STA control window}
2040     \label{fig:staveraging}
2041 \end{wrapfigure}
2042
2043 \textit{Denoise} is generally done on a spatial basis, mediating the values of a group of adjacent pixels to achieve greater uniformity. The effectiveness of Denoise can be increased by also introducing a \textit{time average} between a group of successive frames. The union of these two phases is the basis of the plugin. In fact the smoothing is performed by averaging the color component for each pixel across a number of frames. The smoothed value is used if both the standard deviation and the difference between the current component value and the average component value are below a threshold. The standard deviation is a mathematical index used to estimate the variance of a group of pixels: at high values corresponds more variation of the pixels and therefore more noise.
2044
2045 The \texttt{Selective Temporal Averaging} plugin plays on the homogenization of the values of a group of pixels in a group of frames, based on a threshold below which the original values are left and above which the average is performed and then the noise reduction.
2046
2047 The \texttt{average} and \texttt{standard deviation} are calculated for each of the components of the video. The type of components averaged is determined by the color model of the entire project. The average and standard deviation of the frames can be examined by selecting the specific radio button in the plugin options window.
2048 The region over which the frames are averaged is determined by either a \texttt{fixed offset} or a \texttt{restart marker system}. In a restart marker system, certain keyframes are marked as beginning of sections. Then for each section, the frames surrounding the current frame are used as the frames to average over, except when approaching the beginning and end of a section, where the averaging is performed over the $N$ beginning or ending frames respectively.
2049
2050 An example of common usage is to select the number of frames you wish to average.
2051
2052 \begin{enumerate}
2053     \item Enter a reasonable number of frames to average (for example, $10$).
2054     \item Select the \texttt{Selective Temporal Averaging} method and enter $1$ and $10$ for all the \texttt{Av. Thres.} and \texttt{S.D. Thres.} respectively. This basically causes all pixels to use the average value.
2055     \item Turn the \texttt{mask} for the first component on. This should make the whole frame have a solid color of that specific component.
2056     \item Slowly reduce the \texttt{S.D. Thres.} value. As you do so, you will notice that the regions vastly different from the average will have a flipped mask state. Continue to reduce the threshold until you reach the point at which non-moving regions of the video have a flipped masked state. This value is known as the \textit{noise-floor} and is the level of natural noise generated by the CCD in the camera.
2057     \item Repeat the same procedure for the \texttt{Av. Thres.}
2058     \item Turn off the \texttt{mask}.
2059     \item Repeat this for all channels.
2060 \end{enumerate}
2061
2062 \subsection{Sharpen}%
2063 \label{sub:Sharpen}
2064
2065 Sharpen the video, either the \texttt{luminance}, \texttt{horizontal}, or \texttt{interlace}.
2066
2067 \subsection{Shift Interlace}%
2068 \label{sub:shift_interlace}
2069
2070 Shift the interlace lines using \texttt{odd} or \texttt{even}.
2071
2072 \subsection{Sketcher}%
2073 \label{sub:Sketcher}
2074
2075 Now you can sketch \textit{lines}, \textit{curves} or \textit{shapes}, on your video in different colors using various pen widths and pen type with the \texttt{sketcher} plugin. You can even fill them. Getting started is fairly easy --- simply hold down the \texttt{shift key} while using the \texttt{left mouse button} to create a bunch of points in the compositor window. However, to do more than that you will need to understand the buttons and options or you may end up with unexpected results.
2076
2077 (figure~\ref{fig:sketcher}) shows the Sketcher gui and the sketch lines/curves created in the Compositor.
2078
2079 \begin{figure}[hbtp]
2080     \centering
2081     \includegraphics[width=0.8\linewidth]{images/sketcher.png}
2082     \caption{Sketcher control window and sketch on Compositor}
2083     \label{fig:sketcher}
2084 \end{figure}
2085
2086 In the screencast, note the Sketcher window gui \textit{Curve top section} and the \textit{Point bottom section}. The pink circle sketch is $id\, \#1$ in the curve section. Since $id\, \#3$ is highlighted in the Curve section, the X/Y coordinates in the Point section below show the points used to create the blue shape. Point 6 is selected so we see a red crosshair (\textit{Drag point}) inside the rectangle. Finally, the yellow arrow on the image is $id\, \#2$ curve.
2087
2088 \subsubsection*{Some basic rules}%
2089 \label{ssub:some_basic_rules}
2090
2091 Uncheck \texttt{Drag} before rendering; if you do not uncheck, the drag points will show in your output.
2092 Drag must be checked on to edit the data. Drag must be checked off to use \texttt{Click to play}.
2093 If the drag button flickers when clicked then another window has drag focus. Un-focus it first.
2094 Turn drag off to see what the sketcher figure will look like when rendered.
2095
2096 Curves can be any number of points or just a single point.
2097 You must create a \texttt{new} curve if you want a new string of points not connected to the current curve.
2098 Highlight the curve $id\, \#$ for a specific curve to modify its values.
2099 \texttt{Left mouse click} or \texttt{right mouse click} on an existing point on the highlighted line/curve $id\, \#$ will automatically highlight the selected point in the Point section of the gui and turn red in the image.
2100
2101 There will always be $1$ empty curve automatically defined when you start or even reset.
2102 You can not delete the empty default curve but you can use it for a curve.
2103
2104 LMB click almost anywhere on the compositor screen will automatically show, in the currently highlighted curve, the closest point by turning it red.
2105
2106 There is no \textit{undo} recorded between gui updates. Recommend using the option \texttt{b} to save a backup if you get to a place where you want to make sure you do not lose your sketch.
2107
2108 \begin{table}[h] 
2109     \caption{Shortcuts for Sketcher}
2110     \small
2111     \label{tabular:sketcher}
2112     \begin{center}
2113         \begin{tabular}{m{12em}m{12em}m{12em}}
2114             \toprule
2115             \textbf{Compositor: Mouse usage} &
2116             \textbf{Compositor: Action} &
2117             \textbf{Plugin GUI}\\\midrule
2118             shift+left mouse button &
2119             create a new line point &
2120             New button in Point (line)\\\midrule
2121             shift+right mouse button &
2122             create a new arc (curve) point &
2123             New button in Point (curve)\\\midrule
2124             left mouse button &
2125             select a single line point &
2126             Click point listbox item \\\midrule
2127             right mouse button &
2128             select a single arc (curve) point &
2129             Click curve listbox item \\\midrule
2130             ctrl+left mouse button &
2131             drag point & \\\midrule
2132             ctrl+right mouse button &
2133             drag curve & \\\midrule
2134             alt+left mouse button &
2135             drag all of the curves together & \\\midrule
2136             alt+right mouse button &
2137             create a new curve &
2138             New button in Curve section \\\midrule
2139             ctrl+shift+left mouse button &
2140             create a new fill point &
2141             New button in Point (fill) \\\midrule
2142             ctrl+shift+right mouse button &
2143             create a new off point &
2144             New button in Point (off) \\\midrule
2145             delete key &
2146             deletes highlighted points &
2147             Del button in Point section \\\midrule
2148             delete key+shift &
2149             deletes highlighted curves &
2150             Del button in Curve section \\
2151             \bottomrule
2152         \end{tabular}
2153     \end{center}
2154 \end{table}
2155
2156 \subsubsection*{Other Button and Label Descriptions}%
2157 \label{ssub:other_button_label_description}
2158
2159 \begin{description}
2160     \item[Color] refers to the current curve pen color. Click on the \textit{Color rectangle} to bring up the Color window to change any of the color values, including alpha.
2161     \item[Drag] check to create curves and to be able to see any Off type curves. Uncheck for render/viewing.
2162     \item[Reset] --- in the \textit{Curve section}, all of the curve lines will be deleted except for an empty default curve.
2163     --- in the \textit{Point section}, all points for the highlighted curve in the Curve section will be deleted.
2164     \item[Width] integer width of line; width of $1$ is the default; width of $0$ is the smallest size of $1$ pixel.
2165     \item[ID] is the label number of the curve or point.
2166     \item[Pen] value can be set with the pulldown to \textit{box} (a square), \textit{+}, \textit{/}, \textit{x} or \textit{off}. The default is \textit{x}.
2167     \item[Alpha] alpha value as set in the Color window. Default is $1$ which is totally opaque.
2168     \item[Arc Type] value can be set with this pulldown, which is to the right of the \texttt{Drag} checkbox, to either \textit{off}, \textit{line}, \textit{curve}, or \textit{fill}. Off is the default. If the line type is off when you uncheck drag, you will no longer see the line/curve. Fill specifies a point be inside the region to be filled with the chosen color. Multiple fill points can be used within a single curve.
2169     \item[Up] moves the highlighted Curve or Point Up in the stacking order. Multiple points, but not multiple curves, can be highlighted and moved.
2170     \item[Dn] moves the highlighted Curve or Point(s) Down in the stacking order.
2171     \item[X] is the point’s $X$ coordinate.
2172     \item[Y] is the point’s $Y$ coordinate.
2173 \end{description}
2174
2175 \subsubsection*{ID number detailed information}%
2176 \label{ssub:id_number_detailed_information}
2177
2178 Points and curves are identified by numeric ids, and not the table position. This is so that deleting and inserting points/curves does not shift the interpretation of which points are associated for interpolation. For purposes of this discussion, \textit{prev} refers to \textit{previous}. The prev keyframe constitutes the draw list of curves and points. The prev ids are used to access the next keyframe interpolation input data. When \textit{next} exists for prev.id the interpolation functions apply. When next does not exist, prev is returned for the interpolation value. The keyframes may be any id sequence; both the prev and next keyframe id sequences are arbitrary non-unique sets. This means that if an id is specified redundantly, it causes a redundant draw when it is the prev keyframe, and only the last item with the id in the next keyframe is used for interpolation.
2179
2180 \subsubsection*{Fill detailed information}%
2181 \label{ssub:fill_detailed_information}
2182
2183 The \textit{fill} point is a marker point, and not really part of the curve. That point identifies the inside of the loop. It can also be used to identify the outside of the loop in order to fill that. The loop is created by drawing a line draw from the last point to the first point in the curve. The line type of this last segment is from the last point of the curve. If there are isolated loops in the curve (it is self intersecting) then you will be able to use multiple fill points to fill these regions.
2184
2185 \subsection{Sphere Cam}%
2186 \label{sub:sphere_cam}
2187
2188 Converts multiple fisheye images into a panoramic projection.
2189
2190 \subsection{Swap Frames}%
2191 \label{sub:swap_frames}
2192
2193 Swap frames with $0-1 2-3 4-5\dots$ or $1-2, 3-4, 5-6\dots$
2194
2195 \subsection{Swap channels}%
2196 \label{sub:swap_channels}
2197
2198 Swap R G, B, Alpha with another color channel.
2199
2200 \subsection{Threshold}%
2201 \label{sub:threshold}
2202
2203 \texttt{Threshold} converts the image to pure luminance, and replaces pixels with one of three colors based on the luminance. Pixels with luminance values in the low range are replaced with black, pixels in the middle range are replaced with white, and pixels in the high range are replaced with black. \texttt{Color} and \texttt{alpha} (transparency) for each range are configurable with the buttons and interpolate according to keyframes.
2204
2205 The threshold window shows a \textit{histogram} of luminance values for the current frame. \texttt{Click dragging} inside the histogram creates a range (blue) to convert to white. \texttt{SHIFT-clicking} extends one border of this range. Values for the threshold range can also be specified in the \texttt{text boxes}.
2206
2207 This effect is basically a primitive \textit{luminance key} to produce a \textit{matte}. A second track above the track with the threshold effect can be \textit{multiplied}, resulting in only the parts of the second track within the threshold being displayed.
2208
2209 \subsection{Time average}%
2210 \label{sub:time_average}
2211
2212 Time average is one effect which has many uses besides creating trail patterns of moving objects (figure~\ref{fig:timeaverage}).
2213 The main use is reducing noise in still images (or in the motionless parts of a video). Merely point a video camera at a stationary subject for $30$ frames, capture the frames, and average them using time average and you will have a high quality print. In floating point colormodels, time average can increase the dynamic range of low quality cameras.
2214
2215 Inside the time average effect is an accumulation buffer and a divisor. A number of frames are accumulated in the \textit{accumulation} buffer and divided by the divisor to get the average (for $10$ accumulated frames the divisor is $10$). Because the time average can consume large amounts of memory, it is best applied by first disabling playback for the track, dropping the time average in it, configuring time average for the desired number of frames, and re-enabling playback for the track.
2216
2217 \begin{figure}[hbtp]
2218     \centering
2219     \includegraphics[width=0.35\linewidth]{images/timeaverage.png}
2220     \caption{GUI for Time Average}
2221     \label{fig:timeaverage}
2222 \end{figure}
2223
2224 \begin{description}
2225     \item[Frames count] this determines the number of frames to be accumulated in the accumulation buffer. Ranges from $1 to 1024$ frames.
2226     \item[Accumulate] this outputs the accumulation buffer without dividing it.
2227     \item[Average] this causes the accumulation buffer to be divided before being output. This results is the average of all the frames. The result is similar to \texttt{Selective Temporal Averaging}, but not configurable.
2228     \item[Replace] (\textit{Threshold}, \textit{Border}): causes the accumulation buffer to be replaced by any pixels which are not transparent. In combination with motion tracking it allows entire sequences to be combined to form panoramas.
2229     \item[Restart for every frames] if an effect before the time average is adjusted the time average normally does not reread the accumulation buffer to get the change. This forces it to reread the accumulation buffer when other effects change.
2230     \item[Don’t buffer frames] in order to represent the accumulation of only the specified number of frames, the time average retains all the previous frames in memory and subtracts them out as it plays forward. It would run out of memory if it had to accumulate thousands of frames. By disabling subtraction the previous frames are not stored in memory and only the average function is affected by the frame count.
2231 \end{description}
2232
2233 \subsection{Timefront}%
2234 \label{sub:timefront}
2235
2236 Space-temporal warping enables time to flow differently at different locations in the video (figure~\ref{fig:timefront}).
2237 \begin{wrapfigure}[13]{O}{0.3\linewidth} 
2238     \vspace{-2ex}
2239     \includegraphics[width=0.8\linewidth]{images/timefront.png}
2240     \caption{Temporal bands for Timefront}
2241     \label{fig:timefront}
2242 \end{wrapfigure}
2243 This plugin divides the frame into segments (bands) whose type, position and size can be configured at will. Each segment will move with a different speed from the others, greater than the band that precedes it and less than the band that follows.
2244
2245 \texttt{Type} allows you to choose a \textit{Linear} or \textit{Radial} segmentation; or to make it depend on the alpha channel or on another track (with \textit{Shared Effect}). In the case of Linear you can choose the orientation of the strips (\texttt{Angle}); in the case of Radial you can choose the coordinates (\texttt{X,Y}) of the center. For a more precise adjustment we can make the bands visible with the button \texttt{Show Grayscale} (for tuning).
2246
2247 With \texttt{Inner} and \texttt{Outer Radius} we can position the beginning and end of the bands in the frame (similar to the \texttt{Gradient} plugin), so you can choose the spatial range in which to apply the effect.
2248
2249 With \texttt{Time Range} we decide the size (and therefore the number) of the bands.
2250
2251 \texttt{Rate} allows you to choose the type of algorithm to use when switching between the start and end bands. You can reverse the direction with the \texttt{Invers} button. The three modes are: \textit{Linear}, \textit{Log} or \textit{Quadratic} (exponential). This is a warping framework plugin based on this article: \url{http://www.vision.huji.ac.il/videowarping/HUJI-CSE-LTR-2005-10_etf-tr.pdf}
2252
2253 \subsection{Title}%
2254 \label{sub:title}
2255
2256 The \texttt{Titler} allows you to add text from within Cinelerra GG. The titler has standard options for font, size, and style plus many options as described next (figure~\ref{fig:title01}).
2257
2258 \begin{description}
2259     \item[Justify] justifies the text relative to the entire frame. Once justified, the $X$ and $Y\, offset$ is applied. This allows text to be justified while at the same time letting you push it within the title safe region.
2260     \item[Motion type] scrolls the text in any of the four directions. When using this, the text may disappear. Make sure the speed is set to a reasonably high value (for example $150$) and move the insertion point along the timeline until the text is far enough along the animation to reappear. The text scrolls on and scrolls off. Setting \texttt{loop} causes the text to scroll completely off and repeat. Without loop the text scrolls off and never reappears. The speed of the animation is determined by speed in pixels per second. Set it higher to speed up the animation.
2261     \item[Smooth] with \texttt{Chroma Key}, a shadow may show; remove by enabling this to add/remove the shadow.
2262     \item[Drop shadow] draws a black copy of the text to the bottom right of the original text. This is useful when drawing text over changing video to keep the border always visible.
2263     \item[Fade in/Fade out] are a second type of animation. If the fade seconds are $0$, no fading is done.
2264     \item[Color and Outline] allows you to pick the color for using to draw the text or its outline.
2265     \item[Stamp timecode] replaces text with the current position on the timeline in seconds, frames or samples.
2266 \end{description}
2267
2268 \begin{figure}[hbtp]
2269     \centering
2270     \includegraphics[width=0.9\linewidth]{images/title01.png}
2271     \caption{GUI of the Title plugin}
2272     \label{fig:title01}
2273 \end{figure}
2274
2275 To create special effects for your title you can place it on a dedicated track and insert other realtime video effects just under the title effect and/or use camera and projector. With keyframing you can animate your title and make it change position, size, color, transparency, texture, or shape over time.
2276
2277 For improving playback performances of titles with effects, you can reduce the size of the dedicated track. Right click on the track and select \texttt{Resize track\dots} Enter the smallest resolution that still keeps the title visible.
2278
2279 To include graphical elements like \textit{logos}, you may want to import your title as a PNG image (alpha channel transparency is possible), move it with camera and projector or add effects.
2280
2281 \subsubsection*{Adding fonts to the titler}%
2282 \label{ssub:adding_fonts_to_titler}
2283
2284 The X Window system originally did not have a suitable font renderer for video. It also is restricted to the current bit depth. It does not have a convenient way to know which fonts work with the suitable font renderer in the desired bit depth. The easiest way we have found to support fonts in the titler is to have a directory for them at \texttt{/usr/lib/cinelerra/fonts}.
2285
2286 The titler supports mainly \textit{TTF}, true type fonts. It supports others but TTF are the most reliable. To add true type fonts, copy the \texttt{.TTF} files to the fonts directory. In that directory run
2287 \vspace{1ex}
2288 \begin{lstlisting}[language=bash]
2289     # /usr/lib/cinelerra/fonts
2290     ttmkfdir && mv fonts.scale fonts.dir
2291 \end{lstlisting}
2292 and restart Cinelerra. The new fonts should appear. The usage of ttmkfdir changes frequently so this technique might not work. 
2293
2294 If the video is displayed on a consumer TV, the outer border is going to be cropped by $5\%$ on each side. To avoid text which is too close to the edge looking bad, you may want to enable the \texttt{title-safe} tool in the compositor window. The text should not cross the inner rectangle.
2295
2296 \subsubsection*{Some recently added options}%
2297 \label{ssub:some_recently_added_options}
2298
2299 \begin{description}
2300     \item[Drag] initial default checkbox is \texttt{off} so that the Title plugin will work as it always has.
2301     \begin{description}
2302         \item[Anchors] When you turn on the Drag feature, nine different anchors/handles will appear on compositor window. The \textit{middle anchor} allows you to drag your title wherever you want in the compositor window ($X, Y coordinates$). The other 8 handles, drawn as arrows in each corner and in the middle of each side, let you change the size of the drag area box so that your title is within that area if it fits and as it is directed.
2303         \item[W/H] the values in these 2 boxes specify the size of the drag area box measured in pixels as shown in the compositor window. You can set these manually and if you can't see the location of your box or find your handles, set them to zero because $0$ sets it to the same as the width/height of the media.
2304         The Drag effect ignores all boundaries, including the \textit{Title Safe Region} of the Compositor so that if you drag your titles off the screen, it will look like they disappeared completely. Reset X and Y to reasonable values to have it reappear. The Title \textit{text}, \textit{background}, and \textit{pngs} are applied on a single layer so that they will drag together as an entity. All of the Title capabilities work in conjunction with dragging so if you want to justify the title, you can still use the \textit{Left/Center/Right/Top/Mid/Bottom} within the drag area. Be sure to turn off Drag when rendering or the box will show in the video; keep in mind that drag bars do not appear until there is some text in the text box and you can not actually drag until the Title window controls are available.
2305     \end{description}
2306     \item[Attributes] in the Text box where you type your Title information, you can now change several attributes to give you plenty of flexibility (figure~\ref{fig:title02}). Each of these special attributes begin with an open angle bracket < and ends with a closing angle bracket >. Until the closing angle bracket is keyed in, the actual characters you type, will be seen in the compositor window. In addition, if you do not use the exact syntax or you keyin a filename that is not available, all of the characters will continue to show up. This helps to see what needs to be fixed or is missing. The attributes usage is described in the table below.
2307 \end{description}
2308
2309 \begin{figure}[hbtp]
2310     \centering
2311     \includegraphics[width=0.3\linewidth]{images/title02.png}
2312     \caption{Pulldown Attributes}
2313     \label{fig:title02}
2314 \end{figure}
2315
2316 \begin{center}
2317     \small
2318     \begin{longtable}{{m{6em}m{14em}m{14em}}}
2319         \caption{Titler attributes}
2320         \label{tabular:titler} \\ % note that double backslash is mandatory here
2321         \toprule        
2322         \multicolumn{1}{c}{\textbf{Attribute name}}&\multicolumn{1}{c}{\textbf{Attribute value}}&\multicolumn{1}{c}{\textbf{Notes}}\\        
2323         \midrule \endhead  % here the common page header
2324         
2325         color &
2326         color name such as RED from \textit{<cin\_path>/guicast/colors.h} &
2327         Or use the hex value like \textit{\#a000a0}; color-hex.com shows examples \\\midrule
2328         font &
2329         exact name from \textit{Font} pulldow &
2330         When you set font, bold/size and  italic will be as currently set up \\\midrule
2331         alpha &
2332         floating-point number between 0 and 1&
2333         0 is transparent; 1 is opaque \\\midrule
2334         size &
2335         + increases the size by $\frac{5}{4}$, - decreases $\frac{4}{5}$ or use a number > 0 but less than 2048 &
2336         Examples: \textit{<size +++>}, or \textit{<size ->} or \textit{<size 14.5>} (floating-point ok) \\\midrule
2337         png &
2338         filename of a \textit{.png} file &
2339         Example, add a logo. Full pathname needed if not in current directory \\\midrule
2340         bold &
2341         1 for \textit{on} (default) or use 0 for \textit{off} &
2342         Font used must have bold available \\\midrule
2343         italic &
2344         1 for \textit{on} (default) or use 0 for \textit{off} &
2345         Font must have italic already set up \\\midrule
2346         blink &
2347         a number in seconds to flash on and off; a negative number for fade in and out &
2348         Can be a floating-point number; \textit{<blink>} with no value is like 1 \\\midrule
2349         ul &
2350         underline 1 for \textit{on} (default), 0 for \textit{off} &
2351         \\\midrule
2352         caps &
2353         1 for \textit{on}, 0 for \textit{off}, -1 for lower case &
2354         If no value set, treated same as 1 \\\midrule
2355         sup &
2356         1 for superscript; 0 ends; -1 for subscript; positive bumps up by $\frac{1}{2}$ of font size;  negative sinks by 1/2 of current size &
2357         Size of text will be $\frac{1}{3}$ of font size; example: \textit{12<sup 1>10<sup 0>}; <sup> with no values, acts like 1 \\\midrule
2358         fixed &
2359         number of pixels between characters;  fixed with no value uses $\frac{3}{4}$ current size &
2360         A fixed font is very useful for tables; /fixed reverts to previous fixed size \\\midrule
2361         nudge &
2362         x,y to move the text by that amount;  displacement is in number of pixels. Can be negative or positive &
2363         Example: \textit{<nudge 8,8>abc</nudge>} \\\midrule
2364         smooth &
2365         add anti-aliasing to smooth jagged edges &
2366         Turn off smooth for chroma key
2367         \\\bottomrule        
2368     \end{longtable}
2369 \end{center}
2370
2371 These attributes stay in effect until you change them or reset them. Additional cpu time is needed for the \textit{blink} attribute because it requires redrawing every frame and for the background option described below. Note that some Title window controls can not be set, such as Justify and Outline color. The lines below are examples for testing purposes. The accompanying screenshot displays the corresponding cinelerra output.
2372
2373 \vspace{1ex} Examples of Title line keyins:
2374
2375 Figure~\ref{fig:title03}.
2376
2377 \vspace{1ex}
2378 \begin{lstlisting}[language=bash]
2379 <size 15>Buddy, the <color red><bold 1>bad dog</bold><color white> ate my homework !<png /tmp/buddy.png><ul 1><size +>There are<ul 0><size +>2<sup 1>10<sup 0>cats <font Action man (misc)>to chase?
2380 \end{lstlisting}
2381
2382 \begin{figure}[hbtp]
2383     \centering
2384     \includegraphics[width=0.9\linewidth]{images/title03.png}
2385     \caption{Final result of the exemple}
2386     \label{fig:title03}
2387 \end{figure}
2388
2389 \paragraph{Special Characters (< > / \textbackslash \#)} Besides the previously described <, >, and / characters, there are two special characters: backslash “\textbackslash”, and the pound sign “\#”. The backslash character is used for two things. With the advent of the attribute name and value, your line may become quite long so you can use “\textbackslash” followed by the carriage return to continue on the next line as if it is just a single line. It also can be used to designate that the following character does not represent the beginning of an attribute. For example, if you want to use the opening angle character “<“ as a title character, precede it with the backslash character. The pound sign, “\#”, designates the whole line as a comment or if in the middle of the line, then the rest of the line is a comment (this includes the carriage return).
2390
2391 \begin{description}
2392     \item[Background] in this box you can keyin the name of a file of the type that cinelerra accepts and use that file as a background for your Title characters. This will be seen in the compositor window on top of the video that is loaded in the main track canvas. Besides typing in the filename, you must also check the checkbox. This makes it easy to turn it \texttt{on} and \texttt{off} to see what it looks like. Next to the background box is a \texttt{Loop} checkbox. If the background file takes less time than the main track canvas video to run, you can turn on the loop checkbox so that it runs over and over again to match the time size of your video.
2393     \item[Stroker] to add \textit{pen strokes} to the text letters, adjust the stroke width numerically. This looks particularly nice on certain fonts and with a negative adjustment of the \texttt{Drop shadow}.
2394     \item[Unicode Insertion] if you want to enter a special character like the mathematical \textit{summation} symbol, you can use the unicode equivalent to do so. \texttt{Ctrl-Shift-U} followed by $2022$ and a carriage return is an example of the bullet. Refer to section 40.11 for details.
2395     \item[Popup Helper] put your cursor where you want to add an attribute, then right mouse will bring up a list of the available attributes for you to choose, along with a submenu to choose from. The program will insert that attribute for you and all you have to add is a value when required! (see figure~\ref{fig:title02}).
2396 \end{description}
2397
2398 \subsubsection*{Color Picker Usage}%
2399 \label{ssub:color_picker_usage}
2400
2401 The Text Color window has several enhanced features as listed here and seen in figure~\ref{fig:title04}.
2402
2403 \begin{enumerate}
2404     \item The hex value of the color you choose shows in the textbox and you can also keyin a value there.
2405     \item A small square next to the hex text box, is a green \textit{eyedropper} color picker. Use the left mouse button to click on the square to enable picking and you will see it turn red to designate that it is enabled. Your cursor will switch to a two-colored reticle. You can now move the mouse around to choose a color anywhere on the screen and then click there to have it picked. If you hold down the right or left mouse button while moving, you can see the color changing in the vertical bar in the color palette area as you move to give you a bigger view of the actual color. The eyedropper square is seen in figure~\ref{fig:title04}.
2406     \item A history of $16$ of your last chosen colors is available to easily use again. Any time you choose a new color in any methodology, it will become the latest choice in the history either immediately or after checking \texttt{OK}/and leaving. History shows latest color starting left to right.
2407     \item Besides HSV, RGB, there is also a YUV color model to choose from.
2408     \item Several of these items may have associated \textit{Tool Tips}.
2409 \end{enumerate}
2410
2411 \begin{figure}[hbtp]
2412     \centering
2413     \includegraphics[width=0.5\linewidth]{images/title04.png}
2414     \caption{Screencast showing the Color Picker menu.}
2415     \label{fig:title04}
2416 \end{figure}
2417
2418 \subsubsection*{Font Choice}%
2419 \label{ssub:font_choice}
2420
2421 In order to choose a font faster, you can keyin the first few characters of the font name, being sure to use capital characters if used since it is case-sensitive. The steps to follow are:
2422
2423 \begin{enumerate}
2424     \item next to the font box, click on the \textit{down arrow} pulldown;
2425     \item keyin the first character(s) of the desired font and you will see the first match become highlighted;
2426     \item you can see the characters you keyed in the upper right corner of the fonts.
2427 \end{enumerate}
2428
2429 \subsubsection*{Font Addition / Font Subtraction}%
2430 \label{ssub:font_addition_subtraction}
2431
2432 Some of the system fonts are automatically included in the set of fonts being used by cinelerra. The easiest way to add additional fonts for the Title plugin's set, is to use ones available in specific directories on your computer as long as they have a \texttt{fonts.scale} file already set up. You can run \texttt{mkfontscale} to create this file within that directory. In order to include a specific directory you set an environment variable before starting cinelerra which stays in effect until it is unset or until the next reboot. Below is the method and an example.
2433
2434 \vspace{1ex}
2435 \begin{lstlisting}[language=bash]
2436 export BC_FONT_PATH=<colon-separated-search-path-for-fonts>
2437 export BC_FONT_PATH=/usr/share/fonts
2438 \end{lstlisting}
2439
2440 The current set of fonts in cinelerra's directory will be automatically included and will be the default set if this environment variable is not set. Keep in mind that if you add a lot of fonts, it will considerably slow down the startup every time you bring up the Title plugin. 
2441
2442 If you want to only have a limited number of fonts set up, you can manipulate the cinelerra directory directly at \texttt{<cinelerra\_install\_path> /bin/plugins/fonts}. Here you will find the default set of fonts that come with the install. Copy any other fonts you would like to include here with read permission, delete any fonts you do not want to have, then execute \texttt{mkfontscale} which creates the file \texttt{fonts.scale} that cinelerra will read. However, the next time you install a new version of cinelerra GG, your changes will be written over so you will have to make sure to save them elsewhere and then re-establish. 
2443
2444 If you have problems with a specific font or set of fonts, there is a debug option available to determine which font is an issue. When starting cinelerra, you should set up the variable:
2445
2446 \vspace{1ex}
2447 \begin{lstlisting}[language=bash]
2448 export BC_FONT_DEBUG=1  (default is 0 for no debug)
2449 unset BC_FONT_DEBUG             (to remove debug messages)
2450 \end{lstlisting}
2451
2452 Then start cinelerra from a terminal window to see the fonts being loaded and previewed in the Titler. This should point out any issues. Another debug methodology is to remove all fonts from being used and subsequently add in the ones that you want. For example:
2453
2454 \vspace{1ex}
2455 \begin{lstlisting}[language=bash]
2456 export BC_FONT_PATH=:    (the : “colon” removes all automatic system and cinelerra fonts)
2457 export BC_FONT_PATH=:/usr/share/fonts (remove all fonts and then add /usr/shar/fonts)
2458 \end{lstlisting}
2459
2460 One last item of information about fonts that may lead to some confusion. The checkbox for Bold and Italic will occasionally be ghosted out if no bold or italic version of the selected font is available. This is no guarantee, but currently as good as it can get due to inconsistency in the creation of fonts. It is mostly just a hint. If boxes are checkmarked, but ghosted, you can not uncheck until you change to a font that does not ghost out the boxes. If you use the popup helper with the boxes checked, and attempt to keyin a font that does not have the bold/italic attribute as checked, the font will be considered illegal.
2461 Text: chars is output and updated to indicate the number of characters already used. The only limit to the number of characters based on a count of single $8\, bit$ characters is the available resources on the user computer available for cinelerra use. Keep in mind that unicode or other special characters may consist of $2$ to $4$ $8\,bit$ bytes. Also, newlines are a character and any of the attributes you use count in the total. There is now a horizontal scroll bar as well as the vertical one in the textbox and they only appear when there are more lines or characters that can fit in the original sized textbox.
2462
2463 \subsubsection*{Kerning}%
2464 \label{ssub:kerning}
2465
2466 When using the Titler, kerning is applied in order to allow parts of a letter to go outside the standard sized letter box.  Kerning is the process of adjusting the space between individual letters.  It is not the same as proportional spacing.  In kerning, a bounding box is allowed to overlay another bounding box.  The philosophy here is to aim at the ability to have boxes overlap in order to make the letters look more visually appealing.  Bounding box and escapement are tracked separately.  In addition to adjusting individual letter spacing, the program will also expand the render box in order to have any parts of the letter extend outside the standard letter box.  Kerning is applied to any and all fonts (figure~\ref{fig:title05}).
2467
2468 \begin{figure}[hbtp]
2469     \centering
2470     \includegraphics[width=0.5\linewidth]{images/title05.png}
2471     \caption{Kerning in action}
2472     \label{fig:title05}
2473 \end{figure}
2474
2475 \subsection{Translate}%
2476 \label{sub:translate}
2477
2478 This effect allows displacing, cropping, and/or scaling the source video horizontally and/or vertically. The \texttt{In} and \texttt{Out} parameters operate similar to the \textit{camera} and \textit{projector} functions in the Compositor:
2479
2480 \begin{description}
2481     \item[In X/Y] specifies how many pixels from the left/top of the source you want to start (camera).
2482     \item[Out X/Y] defines where on the screen you want the output to start (projector).
2483     \item[In W/H] defines how many pixels of the source you want to include in each direction.
2484     \item[Out W/H] defines how many pixels on the screen you want that source to take up.
2485 \end{description}
2486
2487 Identical values for both \texttt{In} and \texttt{Out} that are less than the source dimension will simply crop the source. Different values will stretch (or compress if \textit{Out > In}) the source in that direction (and crop if \texttt{In} is less than the source dimension).
2488
2489 This effect supports keyframes so these parameters can change smoothly over time. You can use this effect for many things such as having a cropped insert clip move across the screen, or have it change size or stretch while doing so. Be forewarned though, that for interlaced footage horizontal displacements are likely to destroy the field order, resulting in all sort of flickering and jumping movements.
2490
2491 \subsection{Unsharp}%
2492 \label{sub:Unsharp}
2493
2494 This effect applies a traditional \textit{darkroom} technique, the so called \textit{unsharp mask} to every video frame. With different parameter values, this can be used to soften or to sharpen the image. Its parameters are:
2495
2496 \begin{description}
2497     \item[Amount] moving the slider to the right makes dark areas get darker and light areas get lighter.
2498     \item[Radius] this slider controls how much blurring is used in the \textit{edge-finding} stage. The practical effect of this is to specify how large a region is darkened or lightened.
2499     \item[Threshold] this slider controls how big a difference between a pixel in the blurred copy and the original copy is needed before any darkening or lightening will be applied.
2500 \end{description}
2501
2502 \subsection{Videoscope}%
2503 \label{sub:videoscope}
2504
2505 Videoscope summarizes intensity and color on a calibrated display. The Videoscope can be used in conjunction with other Cinelerra plugins such as \textit{Color 3 Way}, \textit{YUV}, \textit{Brightness}, \textit{Color Balance} or \textit{Histogram} to accurately correct video for contrast, clarity, conformance (to normalize various videos shot under different light settings), or for cinematic purposes. The human eye is not specialized to match precise level of light and color, but Videoscope is. Videoscope contains two displays: the waveform scope and the vectorscope, plus the histograms (figure~\ref{fig:videoscope01}).
2506
2507 \begin{figure}[hbtp]
2508     \centering
2509     \includegraphics[width=0.8\linewidth]{images/videoscope01.png}
2510     \caption{GUI of the Videoscope. You see Histogram, RGB Parade and Vectorscope}
2511     \label{fig:videoscope01}
2512 \end{figure}
2513
2514 \subsubsection*{Waveform/RGB Parade}%
2515 \label{ssub:waveform_rgb_parade}
2516
2517 The \textit{Waveform Scope} displays image intensity (luminance) versus image $X$ position. The \textit{RGB Parade Scope} displays image RGB intensity versus image $X$ position (one graph per channel). The Waveform Scope appears on the left side or in the middle of the Videoscope window. The display is calibrated vertically from $0\%$ intensity (black) at the bottom up to $100\%$ intensity (white) at the top. Each column of pixels in the image corresponds to one column of pixels in the Waveform Scope (figure~\ref{fig:videoscope02}). Note that the height of the values of a waveform/RGB Parade corresponds exactly to the values on the $x\, axis$ in the \textit{histogram}. A vertical/horizontal correspondence is therefore obtained.
2518
2519 \begin{figure}[hbtp]
2520     \centering
2521     \includegraphics[width=0.9\linewidth]{images/videoscope02.png}
2522     \caption{Colortest 75\% with RGB Parade and Waveform}
2523     \label{fig:videoscope02}
2524 \end{figure}
2525
2526 On the left is shown RGB Parade: instead of the color shadows as in figure~\ref{fig:videoscope01}, we have lines representing the color bar test at $75\%$. They are pure colors, so all pixels have the same value. In fact, they are all at the level of $75\%$ except for the $100\%$ white band and the $0\%$ black band. In the waveform on the right, we have the same behavior with regard to luminance: the white band is $100\%$; the black band is $0\%$ and all the others $75\%$.
2527
2528 The Waveform scope helps correct image light levels for contrast range or for conforming light levels on various scenes originally shot on different light settings (figure~\ref{fig:videoscope03}).
2529
2530 \begin{figure}[hbtp]
2531     \centering
2532     \includegraphics[width=0.7\linewidth]{images/videoscope03.png}
2533     \caption{Example of waveform}
2534     \label{fig:videoscope03}
2535 \end{figure}
2536
2537 \subsubsection*{Adjusting luminance}%
2538 \label{ssub:adjusting_luminance}
2539
2540 \begin{enumerate}
2541     \item Insert the \textit{Brightness/Contrast}, \textit{Histogram}, \textit{Color 3 Way} or another video adjustment effect on your track.
2542     \item Insert the Videoscope effect on the track below. Make sure that it is placed below so it can see the adjustment effect's results. If it is not, right-click and move it down.
2543     \item Show both the effect and Videoscope.
2544     \item Adjust the contrast while observing the waveform to match the desired light level.
2545     \item Precise adjustments can be made by measuring the values on the waveform with the crosshair (by click with \texttt{LMB}, and reading numeric values on top left of the window) and reporting these numbers in the effects window (\textit{Histogram Bézier/Curves}, for example).
2546 \end{enumerate}
2547
2548 For instance, if you are looking for maximum contrast range, adjust the \texttt{Brightness/Contrast} levels to align the darkest point on the scope with the $0\%$ level and the brightest portion with $100\%$. Anything above $100\%$ is over saturated. Limits which may be highlighted with checkbox controls.
2549
2550 \subsubsection*{HDTV or sRGB (ITU-R BT.709)}%
2551 \label{ssub:hdtv_srgb_bt709}
2552
2553 The maximum pixel range for HDTV or sRGB is $[0, 255]$. This range corresponds with levels $0\%$ and $100\%$.
2554
2555 \subsubsection*{MPEG or Analog video (ITU-R BT.601)}%
2556 \label{ssub:mpeg_analog_video_bt601}
2557
2558 For analog video or MPEG (including DVD), the maximum range for RGB is $[16, 235]$ ($8\, bit$). For YUV, the maximum range for intensity (Y) is $[16, 235]$ ($8\, bit$). This range corresponds to gray levels from $6\%$ to $92\%$. Reference \texttt{RGB-601} plugin.
2559
2560 \subsubsection*{NTSC Television broadcast}%
2561 \label{ssub:ntsc_television_broadcast}
2562
2563 If you are producing a video for NTSC television broadcast, keep the intensity between $7.5\%$ and $100\%$. The minimum black value which can be broadcast is IRE $7.5\%$ (indicated by the \texttt{7.5 level}), and values below this level are no darker.
2564
2565 \subsubsection*{Vectorscope}%
2566 \label{ssub:Vectorscope}
2567
2568 The Vectorscope displays \textit{hue} (angle on the color wheel) and \textit{saturation} (radius). Each pixel in the source image is drawn as a point on the color wheel. The distance from the center is the color saturation. Gray values are close to the center, and high saturation values are near the perimeter ($100\%$). In the center there is pure white ($0\%$). By clicking with the mouse on the color wheel appear radius and circle whose values of hue and saturation are shown at the top left of the window, similar to the values of $X$ and luminance of the Waveform and RGB Parade (figure~\ref{fig:videoscope04}).
2569
2570 Vectorscope is used as monitor with other plugins to correct color, adjust image tint, and apply other effects for cinematic effects, image correction, or to conform images to look the same. For example, skin tones are found along an axis (\textit{+ I-line}) between yellow and red, and between $0$ and $50\%$ saturation values. The blue of the sky is more or less along the opposite axis to that of the skin (\textit{- I-line}), with a much wider saturation range.
2571
2572 \begin{figure}[hbtp]
2573     \centering
2574     \includegraphics[width=0.9\linewidth]{images/videoscope04.png}
2575     \caption{Balancing a yellow dominace tint}
2576     \label{fig:videoscope04}
2577 \end{figure}
2578
2579 In figure~\ref{fig:videoscope04}, the top image is white balanced. Vectorscope shows many pixels in the yellow region and few in the white region. To remove the yellow tint, the Color Balance effect is used to first shift the vectorscope plot towards magenta (Mg), and then towards blue (B) until the region previously near the center surrounds the center. In the bottom image, yellow highlights have become white highlights (arrows). Note that the corresponding features in waveform also appear whiter (arrows).
2580 The Vectorscope can also be used to verify that the video output will display properly on various monitors. Any points along the inner radius will be displayed as pure white and any points above the $100\%$ radius, will probably not be correctly displayed on the screen.
2581
2582 \subsubsection*{Histogram}%
2583 \label{ssub:histogram}
2584
2585 You can also display the 4 histograms (master or RGB) on the left of the window. (see figure~\ref{fig:videoscope01}).
2586
2587 \subsection{Wave}%
2588 \label{sub:wave}
2589
2590 The \texttt{wave} effect adds waves on the image. \textit{Amplitude}, \textit{Phase}, and \textit{Wavelength} parameters can be adjusted.
2591
2592 \subsection{Whirl}%
2593 \label{sub:whirl}
2594
2595 Creates a whirl (spiral) of the video around the center.
2596
2597 \subsection{YUV}%
2598 \label{sub:yuv}
2599
2600 Modify the Y, U, V settings.
2601
2602 \subsection{YUV411}%
2603 \label{sub:yuv411}
2604
2605 Modify the 411 yuv to look like 420 color space instead.
2606
2607 \subsection{YUVShift}%
2608 \label{sub:yuvshift}
2609
2610 This effect is used for YUV input video from older cameras using $3$ sensors. It is possible to have misalignment of the $3$ sets of numbers: \textit{Y}, which represents the luminance or brightness component, and for \textit{U} and \textit{V} representing the chrominance (color) components. If they were misaligned in the video, you can use \texttt{YUVShift} to realign. To move a specific component up/down, modify the \texttt{dy} value using the slider bar in the RGBShift window. To move a component left/right, modify the corresponding \texttt{dx} value. If you are using an RGB color space, you will want to use the \texttt{RGBShift} effect instead.
2611
2612 Figure~\ref{fig:yuvshift} (top) shows the blue \textit{U} component aligned too far to the left. And the red \textit{V} component is misaligned too far to the right. Note the \texttt{U\_dx} current slider bar set to $0$ as shown by the yellow box value in the YUVShift plugin window. All components are currently at zero.
2613 A corrected video image is shown in the bottom. Now the red and blue colors are correctly aligned. Note how \texttt{U\_dx} is now at $+20$ and \texttt{V\_dx} is now negative to realign the image.
2614
2615 \begin{figure}[hbtp]
2616     \centering
2617     \includegraphics[width=0.7\linewidth]{images/yuvshift.png}
2618     \caption{Before and after YUVShift adjusting}
2619     \label{fig:yuvshift}
2620 \end{figure}
2621
2622 \subsection{Zoom Blur}%
2623 \label{sub:zoom_blur}
2624
2625 Blurs the video from the center outwards, like the sun’s rays, and uses a zoom effect.
2626
2627 \begin{description}
2628     \item[X,Y] center of the origin field.
2629     \item[Radius] Zoom on the fields.
2630     \item[Steps] number of blur steps to be used in the calculation. Increasing the number takes more CPU.
2631 \end{description}
2632
2633 Figure~\ref{fig:zoom} shows the parameters: Radius=21 and Steps=3.
2634
2635 \begin{figure}[hbtp]
2636     \centering
2637     \includegraphics[width=0.8\linewidth]{images/zoom.png}
2638     \caption{For clarity of presentation only 3 fields are shown}
2639     \label{fig:zoom}
2640 \end{figure}
2641
2642 \section{OpenCV plugins}%
2643 \label{sec:opencv_plugins}
2644
2645 The \texttt{Find Object} plugin searches a Scene for an Object, and the Object can be overlayed with a Replacement object. It requires the thirdparty \textit{OpenCV} (Open Computer Vision) library and you will have to do your own build. Also, be aware that the two useful algorithms of \textit{Sift} and \textit{Surf} have been removed from versions of OpenCV after version $4$.
2646
2647 There are some potential pitfalls with using this to include:
2648
2649 \begin{enumerate}
2650     \item openCV code is constantly changing, making it difficult to keep the plugin up to date
2651     \item there is some confusion about licensing/patents for specific algorithms
2652     \item some parts don’t work all that well and it can be slow
2653     \item internally the colormodel is converted to greyscale, which means the color information is not used
2654 \end{enumerate}
2655
2656 Because of the build size of opencv, it is not normally included in the thirdparty directory. Building opencv adds a lot of storage demand ($4\,GB$) to the cinelerra build tree, and the opencv compile time is significant. For these reasons, \texttt{findobject} is not normally built. You can however invoke a build which adds findobject to the cinelerra plugin library. Building findobject will configure and build opencv into the thirdparty library build area if needed (it does not rebuild if already done). System builds are possible, but the system compatibility of the newer opencv interfaces can vary between distros. The opencv interface is rapidly changing; we recommend the static library build and link to avoid problems.
2657
2658 \subsection{How to Build OpenCV Plugins}%
2659 \label{sub:how_build_opencv_plugins}
2660
2661 To build findobject and the other plugins using opencv, access the src using git:
2662
2663 \begin{lstlisting}[language=bash]
2664 git clone –depth 1 "git://git.cinelerra-gg.org/goodguy/cinelerra.git" cinelerra5
2665 \end{lstlisting}
2666
2667 then configure the build, but add the \texttt{- -with-opencv} configure parameter.
2668
2669 \begin{lstlisting}[language=bash]
2670 cd <path>/cinelerra-5.1
2671 ./autogen.sh
2672 ./configure <add std params, eg: --with-single-user> --with-findobect=sta
2673 --with-opencv may be set to [<bld>][,<src>]
2674 bld=typ sta,dyn,sys:     sta=static, dyn=shared, sys=system libraries
2675 src=typ git,tar,git=url,tar=url: git (default git_url), tar (default: tar_url)
2676
2677 # For example, like:
2678 --with-opencv=sta
2679 --with-opencv=dyn
2680 --with-opencv=sta,tar=https://cinelerra-gg.org/download/opencv/opencv-20180401.tgz
2681 \end{lstlisting}
2682
2683 Once thirdparty/opencv is built, it will be reused. Use target \texttt{mrclean} to remove \texttt{thirdparty/opencv*}.
2684 Network access is required to obtain the OpenCV source, at least once. You will need a minimum of 
2685 $4\, GB$ in the thirdparty build directory and more time to compile.
2686
2687 To get opencv built in the easiest way possible (need internet access because builds directly from the opencv github but this changes wildly):
2688
2689 \begin{lstlisting}[language=bash]
2690 ./configure <params> --with-opencv=sta,git
2691 \end{lstlisting}
2692
2693 \subsection{Using OpenCV Plugins from the Automatic Builds}%
2694 \label{sub:using_opencv_automatic_builds}
2695
2696 The OpenCV plugins are built only in the 64-bit tarball builds, both static and dynamic. However, due to size these plugins are not included with pkgs. But it is relatively easy to add the current 6 plugins for your distro via a simple procedure of copying the plugins from the tarball to the cin5 install plugin path. They are: 
2697
2698 \begin{lstlisting}[language=bash]
2699 cin/plugins/opencv/findobj.plugin 
2700 cin/plugins/opencv/flowobj.plugin
2701 cin/plugins/opencv/gaborobj.plugin
2702 cin/plugins/opencv/moveobj.plugin
2703 cin/plugins/opencv/puzzleobj.plugin
2704 cin/plugins/opencv/stylizeobj.plugin
2705 \end{lstlisting}
2706
2707 \begin{enumerate}
2708     \item do your package install of the current build for your distro as usual;
2709     \item look in \url{https://cinelerra-gg.org/download/tars} to see your distro name's static tar;
2710     \item download the corresponding distro static tarball;
2711     for example for arch:
2712 \end{enumerate}    
2713     \url{https://cinelerra-gg.org/download/tars/cinelerra-5.1-arch-{date}-x86_64-static.txz}
2714     %\todo{How make a new line into the link?}
2715 \begin{enumerate}[resume]
2716     \item create a temporary directory on your computer;
2717     \item \texttt{cd} that-directory;
2718     \item \texttt{tar -xf} location-of-the-tarball-you-downloaded;
2719     \item \texttt{cp plugins/*obj.plugin <see below for your location>/.} (note the period on the end!)
2720     \item Start cinelerra and look for the six plugins in Video Effects;
2721     \item To reverse this, simply delete the six plugin files (eg.
2722        
2723     \texttt{rm /usr/lib*/cin*/*obj.plugin}).
2724 \end{enumerate}
2725
2726 location for most User installs, this is:
2727
2728 \texttt{<cinlib\_path>/plugins/}
2729
2730 Location for some System installs, this is:
2731
2732 \texttt{/usr/lib/cin/plugins/} (most ubuntu distros)
2733
2734 \texttt{/usr/lib64/cin/plugins/} (Leap distro)
2735
2736 \subsection{Description of Find Object Plugin}%
2737 \label{sub:description_findobj_plugin}
2738
2739 As in the standard OpenCV FindObj program, there are $5$ \textit{detector} methods and $2$ \textit{matcher} methods which can be selected. They detect features and match them as a rectangular projection. The matched region will be overlayed with a replacement image if replace object is enabled. This is done using a variety of feature detectors and region matches. The match works by creating sets of Feature points. These points are generated for both the source and reference object frames. Then the two sets are matched for \textit{Homography} (a regional similarity).
2740
2741 \subsubsection*{Matchers}%
2742 \label{ssub:matchers}
2743
2744 \begin{description}
2745     \item[FLANN] Fast Library for Approximate Nearest Neighbors
2746     \item[BF] (flann not selected) Brute Force
2747 \end{description}
2748
2749 \subsubsection*{Detectors Algorithm}%
2750 \label{ssub:detectors_algorithm}
2751
2752 \begin{description}
2753     \item[SIFT] Scale-Invariant Feature Transform
2754     \item[SURF] Speeded-Up Robust Features
2755     \item[ORB] Oriented fast and Rotated Brief
2756     \item[AKAZE] Accelerated Keypoint detector And descriptor Extractor
2757     \item[BRISK] Binary Robust Invariant Scalable Keypoin
2758     \item Don’t Calculate
2759 \end{description}
2760
2761 The cinelerra plugin has several additional features for ease of use and more flexibility. A description of parameters is outlined below.