Mat's mostly extraneous numbers removal
[goodguy/cin-manual-latex.git] / parts / Plugins.tex
index c792a6d4a15ac09148fef7efebbd418f9d5b902b..e8c4a1ce7c01480c6c3820b0398288102eb58607 100644 (file)
@@ -188,11 +188,13 @@ For most User installs, the \texttt{<plugin\_name>.png} file will be located at:
 
 For some System installs, the files might be located at:
 
-\texttt{/usr/lib/cin/plugins/picon/cinfinity} (or cinfinity2, original or
-\todo{raphrase to avoid boarder break}
-smoo\-ther) (ubuntu distros)
+\texttt{/usr/lib/cin/plugins/picon/cinfinity}
 
-\texttt{/usr/lib64/cin/plugins/picon/cinfinity} (or cinfinity2, original or smoother) (Leap distro)
+(or cinfinity2, original or smoother --- ubuntu distros)
+
+\texttt{/usr/lib64/cin/plugins/picon/cinfinity}
+
+(or cinfinity2, original or smoother --- Leap distro)
 
 \subsection{Details on where to put your own Plugin Icons}%
 \label{sub:details_put_plugin_icons}
@@ -247,7 +249,7 @@ For a ladspa plugin, the text line in \$HOME/.bcast5/ladspa\_plugins… as seen
 \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} \\
 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.}
 
-\begin{lstlisting}[language=Bash]
+\begin{lstlisting}[language=Bash,numbers=none]
 cd <cinlib>/plugins            # go to the correct directory
 mkdir -p picon/yournamehere    # create subdirectory if does not exist
 ls -l picon/*                  # list the picon directories
@@ -292,7 +294,7 @@ If there are recommendations for other relevant categories, they can be added. T
 
 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:
 
-\begin{lstlisting}[language=Bash]
+\begin{lstlisting}[language=Bash,numbers=none]
 Video Effects
     - Color_Correction
         Blue Banana
@@ -329,13 +331,13 @@ if using an ffmpeg plugin that uses filters and many passes over the data, the a
 
 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:
 
-\begin{lstlisting}[language=Bash]
+\begin{lstlisting}[language=Bash,numbers=none]
 video_filter=xxxxxx=threads=8 # where xxxxxx is the desired filter
 \end{lstlisting}
 
 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:
 
-\begin{lstlisting}[language=Bash]
+\begin{lstlisting}[language=Bash,numbers=none]
 ffmpeg -i /tmp/filename.mpeg -threads 15 -vf format=rgb24,xxxxxxs=threads=8 -acodec ac3 -vcodec libx265 - y /tmp/x.mp4
 \end{lstlisting}
 
@@ -573,7 +575,7 @@ Change the speed of an audio signal without affecting its pitch.
 
 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:
 
-\begin{lstlisting}[language=Bash]
+\begin{lstlisting}[language=Bash,numbers=none]
 export LADSPA_PATH=/usr/lib/ladspa
 \end{lstlisting}
 
@@ -596,7 +598,7 @@ variable Playback buffer samples}
 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.
 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}.
 
-\begin{lstlisting}[language=Bash]
+\begin{lstlisting}[language=Bash,numbers=none]
 export LV2_PATH=/tmp/j/balance.lv2/usr/local/lib/lv2/:/usr/local/lv2
 \end{lstlisting}
 
@@ -642,7 +644,7 @@ In order to test a particular plugin without bringing up cinelerra, especially f
 \texttt{/cin-path/lv2ui <lv2-uri>} \\
 For example:
 
-\begin{lstlisting}[language=Bash]
+\begin{lstlisting}[language=Bash,numbers=none]
 /tmp/cinelerra-5.1/bin/lv2ui http://calf.sourceforge.net/plugins/Flanger
 \end{lstlisting}
 
@@ -812,7 +814,7 @@ Let us now examine the instruments in \textbf{pane 1}:
 \end{description}
 
 \subsubsection*{Pane 2}
-\label{ssub:pane1}
+\label{ssub:pane2}
 
 This section is used to modify the color of your selection. Descriptive commentary for this pane.
 
@@ -2061,8 +2063,8 @@ With the Scale Ratio plugin you can manipulate your video to maintain the pixel
 
 This plugin is designed to smooth out non-moving areas of a video clip (figure~\ref{fig:staveraging}).
 \vspace{2ex}
-\begin{wrapfigure}[22]{O}{0.4\linewidth} 
-    \vspace{-4ex}
+\begin{wrapfigure}[20]{O}{0.4\linewidth} 
+   % \vspace{-4ex}
     \includegraphics[width=0.9\linewidth]{images/staveraging.png}
     \caption{STA control window}
     \label{fig:staveraging}
@@ -2313,7 +2315,7 @@ The X Window system originally did not have a suitable font renderer for video.
 
 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
 \vspace{1ex}
-\begin{lstlisting}[language=bash]
+\begin{lstlisting}[language=Bash,numbers=none]
     # /usr/lib/cinelerra/fonts
     ttmkfdir && mv fonts.scale fonts.dir
 \end{lstlisting}
@@ -2403,7 +2405,7 @@ These attributes stay in effect until you change them or reset them. Additional
 Figure~\ref{fig:title03}.
 
 \vspace{1ex}
-\begin{lstlisting}[language=bash]
+\begin{lstlisting}[language=Bash,numbers=none]
 <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?
 \end{lstlisting}
 
@@ -2419,9 +2421,7 @@ Figure~\ref{fig:title03}.
 \begin{description}
     \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.
     \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}.
-    \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. Press \texttt{Ctrl-Shift-U} followed by $2022$ and a carriage return is an example of the bullet. Refer to section 40.11
-        \todo{lost link}
-        for details.
+    \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. Press \texttt{Ctrl-Shift-U} followed by $2022$ and a carriage return is an example of the bullet. Refer to section \hyperref[sec:textbox_non_std_character_unicode]{17.5} for details.
     \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}).
 \end{description}
 
@@ -2462,7 +2462,7 @@ In order to choose a font faster, you can keyin the first few characters of the
 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.
 
 \vspace{1ex}
-\begin{lstlisting}[language=bash]
+\begin{lstlisting}[language=Bash,numbers=none]
 export BC_FONT_PATH=<colon-separated-search-path-for-fonts>
 export BC_FONT_PATH=/usr/share/fonts
 \end{lstlisting}
@@ -2475,7 +2475,7 @@ Here you will find the default set of fonts that come with the install. Copy any
 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:
 
 \vspace{1ex}
-\begin{lstlisting}[language=bash]
+\begin{lstlisting}[language=Bash,numbers=none]
 export BC_FONT_DEBUG=1 (default is 0 for no debug)
 unset BC_FONT_DEBUG            (to remove debug messages)
 \end{lstlisting}
@@ -2483,9 +2483,9 @@ unset BC_FONT_DEBUG               (to remove debug messages)
 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:
 
 \vspace{1ex}
-\begin{lstlisting}[language=bash]
-export BC_FONT_PATH=:   (the : “colon” removes all automatic system and cinelerra fonts)
-export BC_FONT_PATH=:/usr/share/fonts (remove all fonts and then add /usr/shar/fonts)
+\begin{lstlisting}[language=Bash,numbers=none]
+export BC_FONT_PATH=:   #(the : "colon" removes all automatic system and cinelerra fonts)
+export BC_FONT_PATH=:/usr/share/fonts #(remove all fonts and then add /usr/shar/fonts)
 \end{lstlisting}
 
 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.
@@ -2691,13 +2691,13 @@ Because of the build size of opencv, it is not normally included in the thirdpar
 
 To build findobject and the other plugins using opencv, access the src using git:
 
-\begin{lstlisting}[language=bash]
-git clone depth 1 "git://git.cinelerra-gg.org/goodguy/cinelerra.git" cinelerra5
+\begin{lstlisting}[language=Bash,numbers=none]
+git clone -depth 1 "git://git.cinelerra-gg.org/goodguy/cinelerra.git" cinelerra5
 \end{lstlisting}
 
 then configure the build, but add the \texttt{- -with-opencv} configure parameter.
 
-\begin{lstlisting}[language=bash]
+\begin{lstlisting}[language=Bash,numbers=none]
 cd <path>/cinelerra-5.1
 ./autogen.sh
 ./configure <add std params, eg: --with-single-user> --with-findobect=sta
@@ -2717,7 +2717,7 @@ $4\, GB$ in the thirdparty build directory and more time to compile.
 
 To get opencv built in the easiest way possible (need internet access because builds directly from the opencv github but this changes wildly):
 
-\begin{lstlisting}[language=bash]
+\begin{lstlisting}[language=Bash,numbers=none]
 ./configure <params> --with-opencv=sta,git
 \end{lstlisting}
 
@@ -2726,7 +2726,7 @@ To get opencv built in the easiest way possible (need internet access because bu
 
 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: 
 
-\begin{lstlisting}[language=bash]
+\begin{lstlisting}[language=Bash,numbers=none]
 cin/plugins/opencv/findobj.plugin 
 cin/plugins/opencv/flowobj.plugin
 cin/plugins/opencv/gaborobj.plugin
@@ -3219,7 +3219,7 @@ If the scale factor is $2$, every $2$ input samples will be reduced to $1$ outpu
 \label{sub:renederd_video_effets}
 
 \subsubsection*{Reframe}%
-\label{ssub:time_stretch}
+\label{ssub:reframe}
 
 This does exactly the same thing as \texttt{ReframeRT} in \textit{Stretch} mode. It multiplies the output frame number by the scale factor to arrive at the input frame number and changes the length of the sequence. Unlike \texttt{ReframeRT}, this must run from the Video menu and render its output. Be aware Reframe does not write the scaled frame rate as the frame rate of the rendered file. It produces a file of scaled length and equal frame rate as the project. The new length is $\frac{1}{scale factor}$ as big as the original sequence.