Andrea fixes
[goodguy/cin-manual-latex.git] / parts / Plugins.tex
index a52a8ef715bd0c80a88432f07527fd0864f71688..c9b11a589f6e5d9e82588acc30a21a9dda2bafdb 100644 (file)
@@ -31,10 +31,10 @@ Note that when you change the plugin icons, your session will automatically save
     \node (img1) [yshift=0cm, xshift=0cm, rotate=0] {\includegraphics[width=0.5\linewidth]{plugin-icons.png}};
     \node [yshift=-6mm, xshift=-1cm,anchor=east] at (img1.north west) (Preferences) {Preferences Window};
     \node [yshift=-14mm, xshift=-1cm,anchor=east] at (img1.north west) (Tab) {Tab section};
-    \node [yshift=-35mm, xshift=-1cm,anchor=east] at (img1.north west) (Icon) {Plugin icon choices};
+    \node [yshift=-34mm, xshift=-1cm,anchor=east] at (img1.north west) (Icon) {Plugin icon choices};
     \draw [->, line width=1mm] (Preferences) edge  ([yshift=-6mm] img1.north west);
     \draw [->, line width=1mm] (Tab) edge  ([yshift=-14mm] img1.north west);
-    \draw [->, line width=1mm] (Icon) edge    ([yshift=-35mm] img1.north west);
+    \draw [->, line width=1mm] (Icon) edge    ([yshift=-34mm] img1.north west);
     \end{tikzpicture}
     \caption{Screencast showing the screen to change your plugin icons set}
     \label{fig:plugin-icons}
@@ -135,11 +135,11 @@ A Presets button on the plugin bar to the left of the Controls and On/Off button
     \begin{tikzpicture}[scale=1, transform shape]
     \node (img1) [yshift=0cm, xshift=0cm, rotate=0] {\includegraphics[width=0.6\linewidth]{preset02.png}};
     \node [yshift=-20mm, xshift=-1cm,anchor=east] at (img1.north west) (Green) {A user preset Green};
-    \node [yshift=-68mm, 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.};
-    \node [yshift=-80mm, 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.};
+    \node [yshift=-67mm, 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.};
+    \node [yshift=-79mm, 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.};
     \draw [->, line width=1mm] (Green) edge  ([yshift=-20mm] img1.north west);
-    \draw [->, line width=1mm] (Textbox.south east) --  ([yshift=-68mm] img1.north west);
-    \draw [->, line width=1mm] (Save.north east) --    ([yshift=-80mm] img1.north west);
+    \draw [->, line width=1mm] (Textbox.south east) --  ([yshift=-67mm] img1.north west);
+    \draw [->, line width=1mm] (Save.north east) --    ([yshift=-79mm] img1.north west);
     \end{tikzpicture}
     \caption{Screencast shows 4 Factory presets as preceded by an *.}
     \label{fig:preset02}
@@ -1030,6 +1030,10 @@ This is a Gaussian type blur. Other blur plugins -- \textit{Linear}, \textit{Mot
     \item[Blur alpha, red, green, blue] specifies which color channels is to be blurred.
 \end{description}
 
+\subsection{BoxBlur}%
+\label{sub:boxblur}
+Based on ffmpeg’s. To blur horizontal, vertical, and with power.\rVery fast
+
 \subsection{Brightness/Contrast}%
 \label{sub:brightness_contrast}
 
@@ -2386,7 +2390,7 @@ There is no \textit{undo} recorded between gui updates. It is recommended that y
 
 \begin{center}
        \small
-       \begin{longtable}{{m{15em}m{13em}m{12em}}}
+       \begin{longtable}{{m{12em}m{13em}m{12em}}}
                \caption{Sketcher controls}
                \label{tabular:sketcher_controls} \\ % note that double backslash is mandatory here
                \toprule
@@ -2975,6 +2979,14 @@ Only for Nvidia GPU and Cuda SDK
 \label{sub:mandelbrot}
 
 Produce fractal figures (figure~\ref{fig:mandelbrot}). Use case:
+
+\begin{figure}[hbtp]
+       \centering
+       \includegraphics[width=0.8\linewidth]{mandelbrot.png}
+       \caption{Mandelbrot Cuda plugin}
+       \label{fig:mandelbrot}
+\end{figure}
+
 \begin{enumerate}
        \item add the Mandelbrot Cuda video effect to the timeline
        \item you must enable Drag in the plugin popup menu
@@ -2983,13 +2995,6 @@ Produce fractal figures (figure~\ref{fig:mandelbrot}). Use case:
        \item so now when you play the video from the beginning because you have keyframes, the fractal will be animated between keyframes.
 \end{enumerate}
 
-\begin{figure}[hbtp]
-       \centering
-       \includegraphics[width=0.9\linewidth]{mandelbrot.png}
-       \caption{Mandelbrot Cuda plugin}
-       \label{fig:mandelbrot}
-\end{figure}
-
 \subsection{N\_Body}%
 \label{sub:n_body}
 
@@ -3032,8 +3037,8 @@ time is significant. For these reasons, \textit{findobject} and the other 5 plug
 included in System build packages.  We recommend using the static library build which has the OpenCV
 plugins included for consistency and to avoid problems.
 
-\subsection{Using OpenCV Plugins from the Automatic Builds}%
-\label{sub:using_opencv_automatic_builds}
+\subsection{Adding OpenCV Plugins to the System Package Builds}%
+\label{sub:adding_opencv_to_system_builds}
 
 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
@@ -3051,7 +3056,7 @@ cin/plugins/opencv/stylizeobj.plugin
 
 \begin{enumerate}
     \item do your package install of the current build for your distro as usual
-    \item look in {\small \url{https://cinelerra-gg.org/download/tars}} to see your distro name's static tar;
+    \item look in {\small \url{https://cinelerra-gg.org/download/tars}} to see your distro name's static tar
     \item download the corresponding distro static tarball;
     for example for arch:
 \end{enumerate}
@@ -3059,25 +3064,24 @@ cin/plugins/opencv/stylizeobj.plugin
     {\small \url{https://cinelerra-gg.org/download/tars/cinelerra-5.1-arch-{date}-x86_64-static.txz}}
 
 \begin{enumerate}[resume]
-    \item create a temporary directory on your computer;
-    \item \texttt{cd} that-directory;
-    \item \texttt{tar -xf} location-of-the-tarball-you-downloaded;
-    \item \texttt{cp plugins/*obj.plugin <see below for your location>/.} (note the period on the end!)
-    \item Start \CGG{} and look for the six plugins in Video Effects;
+    \item create a temporary directory on your computer
+    \item \texttt{cd} that-directory
+    \item \texttt{tar -xf} location-of-the-tarball-you-downloaded
+    \item \texttt{cp plugins/*obj.plugin <see below for your location>/.} (note the period on the end)
+    \item Start \CGG{} and look for the six plugins in Video Effects
     \item To reverse this, simply delete the six plugin files (for example:
 
     \texttt{rm /usr/lib*/cin*/*obj.plugin}).
 \end{enumerate}
 
-location for most User installs, this is:
-
-\texttt{<cinlib\_path>/plugins/}
+The location for most User installs is:
 
-Location for some System installs, this is:
+\hspace{4em}\texttt{<cinlib\_path>/plugins/}
 
-\texttt{/usr/lib/cin/plugins/} (most ubuntu distros)
+Location for some System installs is:
 
-\texttt{/usr/lib64/cin/plugins/} (Leap distro)
+\hspace{4em}\texttt{/usr/lib/cin/plugins/} (most ubuntu distros)\\
+\hspace{4em}\texttt{/usr/lib64/cin/plugins/} (Leap distro)
 
 \subsection{How to Build OpenCV Plugins}%
 \label{sub:how_build_opencv_plugins}
@@ -3088,6 +3092,32 @@ and build OpenCV into the thirdparty library build area if needed (it does not r
 previously).  Network access is required to obtain the OpenCV source, at least once. You will
 need a minimum of $4\, GB$ in the thirdparty build directory and more time to compile.
 
+\subsubsection*{Build using stable tarballs}%
+\label{ssub:stable_tars}
+
+Instead of using the latest git version, there is a custom archive source tarball on the
+website already created to build and test OpenCV versions.  The reason for this is that OpenCV
+is quite volatile, and may or may not work on any given day so this is an already tested version
+that is considered to be more stable.  A build using the tarball requires that your
+system have \textit{wget} already installed to initially download the prepared source tar. 
+There are currently 2 tarballs of stable versions on the website used for user builds.
+The 20180401 version:\newline
+{\small \url{ https://cinelerra-gg.org/download/opencv/opencv-20180401.tgz}}\newline
+works with older version of cmake, and 20200308 is the current 4.2 release:\newline
+{\small \url{https://cinelerra-gg.org/download/opencv/opencv-20200306.tgz}}
+
+To build using the tarballs on the website, use this bld.sh procedure (you may want to run "make
+clean" first):
+\begin{lstlisting}[style=sh]
+#!/bin/bash
+( ./autogen.sh
+  ./configure --with-single-user --with-booby \
+    --with-opencv=sta,tar=http://cinelerra-gg.org/download/opencv/opencv-20200306.tgz
+  make && make install ) 2>&1 | tee log
+mv Makefile Makefile.cfg
+cp Makefile.devel Makefile
+\end{lstlisting}
+
 \subsubsection*{Build using current git version}%
 \label{ssub:current_git}
 
@@ -3161,32 +3191,6 @@ running locally on the build system.  for example:\newline
      \item systemctl start httpd
 \end{enumerate}
 
-\subsubsection*{Build using stable tarballs}%
-\label{ssub:stable_tars}
-
-Instead of using the latest git version, there is a custom archive source tarball on the
-website already created to build and test OpenCV versions.  The reason for this is that OpenCV
-is quite volatile, and may or may not work on any given day so this is an already tested version
-that is considered to be more stable.  A build using the tarball requires that your
-system have \textit{wget} already installed to initially download the prepared source tar. 
-There are currently 2 tarballs of stable versions on the website used for user builds.
-The 20180401 version:\newline
-{\small \url{ https://cinelerra-gg.org/download/opencv/opencv-20180401.tgz}}\newline
-works with older version of cmake, and 20200308 is the current 4.2 release:\newline
-{\small \url{https://cinelerra-gg.org/download/opencv/opencv-20200306.tgz}}
-
-To build using the tarballs on the website, use this bld.sh procedure (you may want to run "make
-clean" first):
-\begin{lstlisting}[style=sh]
-#!/bin/bash
-( ./autogen.sh
-  ./configure --with-single-user --with-booby \
-    --with-opencv=sta,tar=http://cinelerra-gg.org/download/opencv/opencv-20200306.tgz
-  make && make install ) 2>&1 | tee log
-mv Makefile Makefile.cfg
-cp Makefile.devel Makefile
-\end{lstlisting}
-
 \subsection{Description of Find Object Plugin}%
 \label{sub:description_findobj_plugin}