There are realtime effects -- these are the most useful and probably all you will ever need -- and rendered effects.
The rendered effects are discussed separately in the \nameref{sec:rendered_effects} section.
+Effects that begin with the characters F\_ are effects that are part of the FFmpeg software
+as opposed to those coded within the \CGG{} program. These are discussed separately in
+\nameref{sec:ffmpeg_audio_video_plugins}.
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 \CGG{} 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.
\begin{figure}[htpb]
\subsection{Delete Plugins to save Resources Space or make them Unavailable}%
\label{sub:delete_plugin_resouces_unavaible}
-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 \CGG{} binaries. To delete a plugin, highlight the plugin you no longer want in the Resources window then press 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}).
+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 \CGG{} binaries. To delete a plugin, highlight the plugin you no longer want in the Resources window then press 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.
+AppImage does not provide this capability unless you use the workaround as described in the Appendix \nameref{cha:faq_problems_workarounds}.
+
+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}).
\begin{figure}[htpb]
\centering
(or cinfinity2, original or smoother -- Leap distro)
+AppImage does not provide this capability unless you use the workaround as described in the Appendix \nameref{cha:faq_problems_workarounds}.
+
\subsection{Details on where to put your own Plugin Icons}%
\label{sub:details_put_plugin_icons}
\label{sub:example_plugin_icon_testing}
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 \CGG{} and still execute the Blue Banana function.
+AppImage does not provide this capability unless you use the workaround as described in the Appendix \nameref{cha:faq_problems_workarounds}.
For an ffmpeg plugin, create \texttt{ff\_loop.png} and copy it to: \\
\texttt{<cinlib\_path>/plugins/picon/original}. This icon will show up in \CGG{} if original is selected and execute the \textit{F\_loop} function.
\label{sub:delay_audio}
\index{delay audio}
+WARNING: under most circumstances, this is currently crashing due to a bug. Please use
+F\_adelay ffmpeg plugin instead until this is fixed.
In the Delay Audio effect you can specify the number of seconds you want to delay the video track.
\subsection{DeNoise}%
\item[Damp:] echo envelope decay factor used to smooth the cepstrum/correlation data.
\item[Peaks:] number of maximal envelope values used in the echo gain calculation.
\item[Cutoff Hz:] low frequency cutoff value to prevent beat frequency (\textit{heterodyne}) echo canceling.
- \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.
+ \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$ (LMB) 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.
\item[Windows size:] parameter can be set to \textit{Default}, $1024$, $2048$, \dots \textit{doubled values\dots} up to $262144$.
\item[Amplitude:] the cepstrum value at the drag point during manual envelope selection.
\item[Gain:] echo gain setting determined by manual selection.
\label{sub:motion51}
\index{Motion51}
+Note: Motion and Motion51 plugins are complex and slow to use for video stabilization. If you are stabilizing an entire video, you may want to preprocess by using ffmpeg's \textit{vidstabdetect} and \textit{vidstabtransform} plugins before importing the video into \CGG{}.
+
This plugin compensates for unwanted motion and stabilizes the picture. The \textit{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.
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.
\label{sub:motion}
\index{Motion}
+Note: Motion and Motion51 plugins are complex and slow to use for video stabilization. If you are stabilizing an entire video, you may want to preprocess by using ffmpeg's \textit{vidstabdetect} and \textit{vidstabtransform} plugins before importing the video into \CGG{}.
+
The \textit{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.
Motion tracker works by using one region of the frame as the region to track (Match Box). 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.
\label{ssub:tips}
\begin{enumerate}
+ \item Motion plugin\protect\footnote{Thanks to Georgy} algorithm in \CGG{} is rather difficult to understand (the most efficient way to understand it is to look inside its C++ code:). Moreover, it has some tricks that, although can be derived knowing the details of the algorithm, are absolutely non-intuitive by themselves. Moreover, it is rather slow, and the results cannot be visible immediately while altering the settings.
+ \item The Motion plugin \textit{cache} (or\textit{ motion vector} or \textit{tracking file}) sometimes allows to play with very sophisticated techniques. For example, by editing the cache, perhaps with some custom script, you can induce some kind of motion which would be difficult to make in other way. But in the same time the existence of the cache file can trigger user's mistakes. So you must always pay attention, which cache file may be used in the moment. //
+ Motion's cache data are absolute-frame-number based. If you insert some small piece of video before that where the plugin was attached, the frame numbers get displaced relative to the cached numbers, and the result may become incorrectly stabilized.
\item 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.
+ \item It is not possible to switch Motion cache off. While working, \textit{Motion} always looks in its cache. If it contains some data assigned to the current frame numbers, that cached data will be used unconditionally. If not, that data will be calculated, stored in the cache, and later reused, also unconditionally.
+ \item In the Motion plugin dialog there is a button \texttt{Clear tracking file contents}. When in doubt, you can press this button, the cached data will be erased and fresh recalculated on the next pass.
+ \item It is quite usual to wish independent caches for different parts of video. It is possible to set such distinct cache file names (either manually, or let software generate them with \texttt{Generate tracking file name}). When you generate new names, the plugin automatically switches Calculation off, just for security. You switch it on again when needed.
+ \item If \texttt{play track} is switched off for the track where the Motion plugin was attached, the plugin will calculate nothing. Also, if \texttt{Play every frame} was not active in \texttt{Preferences}, some video frames can get skipped from processing.
\item You can try tracking using reverse playback of the track. Sometimes it may lead to a better calculation.
\end{enumerate}
\label{sub:overlay}
\index{overlay video}
-This effect can combine several tracks by using the so called Overlayer. This is a basic internal device normally used by \CGGI{} 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 on \hyperref[cha:overlays]{Overlays} chapter -- PorterDuff.
+This effect can combine several tracks by using the Overlayer. This is a basic internal device normally used by \CGGI{} 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{Addition}, \textit{Subtract}, \textit{Multiply} (Filter), \textit{Divide}, \textit{Max} and \textit{Replace}. For a detailed list and some differences in output expectations, refer to the \hyperref[cha:overlays]{Overlays} chapter -- PorterDuff.
+
The \textit{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:
\item Manipulate the plugin parameters in Track A.
\end{enumerate}
+In the Overlay plugin's parameter window you can choose the overlay "Layer order"
+to select which track plays the role of the "bottom layer" and which plays the
+role of the "top layer". For some overlay modes this can make quite a
+difference, for example the bottom layer is subtracted from the top layer for
+"Subtract" mode. Also in the parameter window, you can choose on which of the tracks
+to overlay the combined output by changing the "Output layer" and it too can make
+quite a difference.
+(Hint: in most cases, you will want to mute the other track so you only see the
+combined output).
+
\subsection{Perspective}%
\label{sub:perspective}
\index{perspective}
\label{sub:reroute}
\index{reroute}
-The \textit{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.
+The \textit{Reroute} plugin\protect\footnote{By Hermann Vosseler} 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.
+
+\begin{description}
+ \item[Target Track:] you can choose between \textit{Top} and \textit{Bottom}.
+ \item[Operation:] you can choose between \textit{Replace Target} (component + alpha channels); \textit{Components Only} (color channels only) and \textit{Alpha Replace} (alpha channel only)
+\end{description}
+
+It works as a 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 target track.
\subsection{Reverse video}%
\label{sub:reverse_video}
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}.
-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
+The titler supports mainly \textit{TTF}, true type fonts. It supports others but TTF are the most reliable. AppImage does not provide this capability unless you use the workaround as described in the Appendix \nameref{cha:faq_problems_workarounds}.
+
+ To add true type fonts, copy the \texttt{.TTF} files to the fonts directory. In that directory run
\vspace{1ex}
\begin{lstlisting}[style=sh]
# /usr/lib/cinelerra/fonts
The OpenCV plugins are built only in the 64-bit tarball builds, both static and dynamic, but due
to size these plugins are not included with pkgs, i.e. the System builds. However it is relatively
easy to add the current plugins for your distro via a simple procedure of copying the plugins
-from the static tarball to the cin5 install plugin path. They are:
+from the static tarball to the cin5 install plugin path (AppImage does not provide this capability). They are:
\begin{lstlisting}[style=sh]
cin/plugins/opencv/findobj.plugin
compression/expansion filter.
\item [F\_acrusher]~\\Reduces audio bit resolution.
\item [F\_acue]~\\Delay filtering to match a cue.
+\item [F\_adecorrelate]~\\Apply decorrelation to input audio stream.
\item [F\_adelay]~\\Delays one or more audio channels.
-\item [F\_adenorm]~\\Remedy denormals by adding extremely
- low-level noise.
+\item [F\_adenorm]~\\Remedy denormals by adding extremely low-level noise.
+\item [F\_adynamicequalizer]~\\Apply dynamic equalization to input audio stream.
+\item [F\_adynamicsmooth]~\\Apply dynamic smoothing to input audio stream.
\item [F\_aderivative]~\\Compute derivative of input audio.
\item [F\_aecho]~\\Adds echoing to the audio.
\item [F\_aemphasis]~\\Audio emphasis.
\item [F\_aformat]~\\Convert the input audio to one of he
specified formats.
\item [F\_afreqshift]~\\Apply frequency shifting to input audio.
+\item [F\_afwtdn]~\\Reduce broadband noise from input samples using Wavelets.
\item [F\_agate]~\\Audio gate.
-\item [F\_aintegral]~\\Compute integral of input audio.
+\item [F\_alatency]~\\Measure filtering latency.
\item [F\_allpass]~\\Applies a two-pole all-pass filter.
\item [F\_aloop]~\\Loops audio samples.
\item [F\_anoisesrc]~\\Generates a noise audio signal.
frame.
\item [F\_aphaser]~\\Adds a phasing effect to the audio.
\item [F\_aphaseshift]~\\Apply phase shifting to input audio.
+\item [F\_apsyclip]~\\Apply Psychoacoustic clipper to input audio stream.
\item [F\_arealtime]~\\Slows down filtering to match realtime.
\item [F\_aresample]~\\Resamples audio data.
-\item [F\_asetrate]~\\Change the sample rate without altering
- the data.
-\item [F\_astats]~\\Shows time domain statistics about audio
- frames.
+\item [F\_asetrate]~\\Change the sample rate without altering the data.
+\item [F\_aspectralstats]~\\Display frequency domain statistical information about the audio channels. Statistics are calculated and stored as metadata for each audio channel and for each audio frame.
+\item [F\_astats]~\\Shows time domain statistics about audio frames.
\item [F\_asubboost]~\\Boost subwoofer frequencies.
\item [F\_asubcut]~\\Cut subwoofer frequencies.
\item [F\_asupercut]~\\Cut super frequencies.
\item [F\_asuperpass]~\\Apply high order Butterworth band-pass filter.
\item [F\_asuperstop]~\\Apply high order Butterworth band-stop filter.
-\item [F\_atempo]~\\Adjusts audio tempo so that when you speed up audio, it will
-adjust the pitch accordingly to make audio sounds more normal, but faster without
-being badly distorted. Its behavior is similar to what can be seen when you watch
-a youtube video, click the gear icon, and select a speed greater or less than 1.
+\item [F\_atempo]~\\Adjusts audio tempo so that when you speed up audio, it will adjust the pitch accordingly to make audio sounds more normal, but faster without being badly distorted. Its behavior is similar to what can be seen when you watch a youtube video, click the gear icon, and select a speed greater or less than 1.
+\item [F\_atilt]~\\Apply spectral tilt filter to audio stream.
\item [F\_atrim]~\\Pick one continuous section from the input,
drop the rest.
\item [F\_bandpass]~\\Applies a two-pole Butterworth band-pass
audio channels. When using this plugin, be sure to \textit{attach
effect} to all audio tracks by dragging the plugin to the $1^{st}$
audio track and then right mouse clicking all subsequent audio
- tracks which brings up an menu. Highlight the effect shown in the
+ tracks which brings up a menu. Highlight the effect shown in the
middle section and click OK.
\item [F\_flanger]~\\Applies a flanging effect to the audio.
\item [F\_haas]~\\Apply Haas Stereo Enhancer for a more
tracks by dragging the plugin to the $1^{st}$ audio track and then
right mouse clicking all subsequent audio tracks which brings up an
menu. Highlight the effect shown in the middle section and click OK.
+\item [F\_tiltshelf]~\\Boost or cut the lower frequencies and cut or boost higher frequencies of the audio using a two-pole shelving filter with a response similar to that of a standard hi-fi’s tone-controls. This is also known as shelving equalization (EQ).
\item [F\_treble]~\\Boosts or cuts upper frequencies.
\item [F\_tremolo]~\\Applies tremolo effect.
\item [F\_vibrato]~\\Applies vibrato effect.
+\item [F\_virtualbass]~\\Apply audio Virtual Bass filter.
\item [F\_volume]~\\Change input volume.
\item [F\_volumedetect]~\\Detect audio volume.
\end{description}
\item [F\_blackdetect]~\\Detect video intervals that are
(almost) black.
\item [F\_blackframe]~\\Detect frames that are (almost) black.
-\item [F\_boxblur]~\\Blurs the input video. Through the
- settings you are able to change the power and the radius of the
- boxblur applied to luma, chroma and alpha.
+\item [F\_blockdetect]~\\Determines blockiness of frames without altering the input frames.
+\item [F\_blurdetect]~\\Determines blurriness of frames without altering the input frames.
+\item [F\_boxblur]~\\Blurs the input video. Through the settings you are able to change the power and the radius of the boxblur applied to luma, chroma and alpha.
\item [F\_bwdif]~\\Deinterlaces the input image.
\item [F\_cas]~\\Apply Contrast Adaptive Sharpen filter to video.
\item [F\_chromakey]~\\Turns a certain color into
\item [F\_colorbalance]~\\Adjusts the color balance.
\item [F\_colorchannelmixer]~\\Adjusts colors by mixing color
channels.
+\item [F\_colorchart]~\\The colorchart source provides a colors checker chart.
\item [F\_colorcontrast]~\\Adjust color contrast between RGB
components.
\item [F\_colorcorrect]~\\Adjust color white balance selectivity
\item [F\_colormatrix]~\\Converts color matrix.
\item [F\_colorize]~\\Overlay a solid color on the video stream.
\item [F\_colorspace]~\\Converts color space.
+\item [F\_colorspectrum]~\\Provides a color spectrum input.
\item [F\_colortemperature]~\\Adjust color temperature of video.
\item [F\_cover\_rect]~\\Find and cover a user specified
object.
\item [F\_gradfun]~\\Debands video quickly using gradients.
\item [F\_gradients]~\\Draws a transparent gradient.
\item [F\_graphmonitor]~\\Show various filtergraph stats.
+\item [F\_grayworld]~\\A color constancy filter that applies color correction based on the grayworld assumption.
\item [F\_greyedge]~\\Estimates scene illumination by grey
edge assumption.
\item [F\_haldclutsrc]~\\Provide an identity Hald CLUT\@.
equalization.
\item [F\_histogram]~\\Computes and draws a histogram.
\item [F\_hqdn3d]~\\Applies a High Quality 3D Denoiser.
-\item [F\_hqx]~\\Scales the input by 2, 3 or 4 using the
- $hq*x$ magnification algorithm.
-\item [F\_hue]~\\Adjust the hue and saturation of the input
- video.
+\item [F\_hqx]~\\Scales the input by 2, 3 or 4 using the $hq*x$ magnification algorithm.
+\item [F\_hsvhold]~\\Turns a certain HSV range into gray values.
+\item [F\_hsvkey]~\\Turns a certain HSV range into transparency.
+\item [F\_hue]~\\Adjust the hue and saturation of the input video.
+\item [F\_huesaturation]~\\Apply hue-saturation-intensity adjustments to input video stream.
\item [F\_idet]~\\Interlace detect Filter.
\item [F\_il]~\\Deinterleaves or interleaves fields.
\item [F\_inflate]~\\Applies inflate effect.
\item [F\_kerndeint]~\\Applies kernel deinterlacing to the
input.
\item [F\_kirsch]~\\Apply kirsch operator.
-\item [F\_lenscorrection]~\\Rectifies the image by correcting
- for lens distortion.
+\item [F\_latency]~\\Measure filtering latency.
+\item [F\_lenscorrection]~\\Rectifies the image by correcting for lens distortion.
\item [F\_life]~\\Generate a life pattern.
\item [F\_limiter]~\\Limit pixels components to the specified
range.
\item [F\_perspective]~\\Corrects the perspective of video.
\item [F\_phase]~\\Phases shift fields.
\item [F\_photosensitivity]~\\Filter out photosensitive epilepsy seizure-inducing flashes.
-\item [F\_pixscope]~\\Pixel data analysis for checking color
- and levels. It will display sample values of color channels.
+\item [F\_pixscope]~\\Pixel data analysis for checking color and levels. It will display sample values of color channels.
+\item [F\_pixelize]~\\Apply pixelization to video stream.
\item [F\_pp]~\\Filters video using libpostproc.
\item [F\_pp7]~\\Applies Postprocessing 7 filter.
\item [F\_prewitt]~\\Apply prewitt operator.
performs a simple/quick $2D$ spatial gradient measurement on the
video (usually a grayscale image). It highlights regions of high
spatial frequency which most ikely correspond to edges.
-\item [F\_rotate]~\\Rotates the input image.
+\item [F\_rotate]~\\Rotates the input image by an arbitrary angle expressed in radians. If you want to rotate
+by degrees, you can use the \textit{rotate} plugin instead.
\item [F\_sab]~\\Applies shape adaptive blur.
-\item [F\_scale]~\\Scale the input video size and/or convert
- the image format.
+\item [F\_scale]~\\Scale the input video size and/or convert the image format.
\item [F\_scdet]~\\Detect video scene change.
+\item [F\_scharr]~\\Apply scharr operator to input video stream.
\item [F\_scroll]~\\Scroll input video horizontally and/or vertically by constant speed.
\item [F\_separatefields]~\\Split input video frames into
fields.
\item [F\_shufflepixels]~\\Shuffles video pixels.
\item [F\_shuffleplanes]~\\Shuffles video planes.
\item [F\_sierpinski]~\\Generate a Sierpinski carpet/triangle fractal, and randomly pan around.
-\item [F\_signalstats]~\\Separates statistics from video
- analysis.
+\item [F\_signalstats]~\\Separates statistics from video analysis.
\index{over sharpened footage}
+\item [F\_siti]~\\Calculate Spatial Info (SI) and Temporal Info (TI) scores for a video, as defined in ITU-T P.910: Subjective video quality assessment methods for multimedia applications.
\item [F\_smartblur]~\\Blurs the input video without impacting
the outlines. Through the settings you can select the radius, the
strength and the threshold of luma and chroma. This plugin can be used to correct
projects / goodguy / cin-manual-latex.git / blobdiff