Andrea added new HV plugins
[goodguy/cin-manual-latex.git] / parts / AuxilaryPrograms.tex
index 963efc8bc3bdfe1f4cc7a9797cf9b03e8724fea8..bf0a54507e9cc10fb2f4bd9b99b8739d5d10dc08 100644 (file)
@@ -3,45 +3,72 @@
 
 \section{Using Ydiff to check results}
 \label{sec:ydiff_check_results}
+\index{Ydiff}
+
+Delivered with Infinity \CGG{} and in the \CGG{} path, there is a file \texttt{ydiff.C} This program compares the output from 2 files to see the differences . Do: \texttt{cd cin\_path} and key in \texttt{make ydiff}.
+
+% The following does not work like this.
+% {                                      % uses braces to localize caption alignment changes.
+% \begin{figure}[h]
+%        \captionsetup{justification=raggedright,singlelinecheck=false}
+%        \includegraphics[width=0.4\linewidth]{ydiff_same.png}
+%        \caption{Exact match}
+%        \vspace{-9cm}
+%        \hspace{0.4\linewidth}
+%        \captionsetup{justification=raggedleft,singlelinecheck=false}
+%        \includegraphics[width=0.4\linewidth]{ydiff_change.png}
+%        \caption{"giraffe" artifacts on 2 files spaced differently}
+% \end{figure}
+% }
+
+% We pack two pictures of unequal height next to each other and
+% align them flush at
+% a) the first line of the caption.
+% b) or tricks with strut, it's flush at the top.
+\begin{figure}[h]
+  \begin{minipage}[t]{0.49\textwidth}
+    \strut\\[-1em]
+    \includegraphics[width=\linewidth]{ydiff_same.png}
+    \caption{Exact match}
+  \end{minipage}
+  \hfill
+  \begin{minipage}[t]{0.49\textwidth}
+    \strut\\[-1em]
+    \includegraphics[width=\linewidth]{ydiff_change.png}
+    \caption{"Giraffe" artifacts on 2 files spaced differently}
+  \end{minipage}
+\end{figure}
 
-Delivered with Infinity \CGG{} and in the \CGG{} path, there is a file \texttt{ydiff.C} This program compares the output from 2 files to see the differences . Do: \texttt{cd cin\_path} and key in \texttt{make ydiff}. 
-
-You can now use this to check the quality differences of various outputs. \ For example, in this same directory key in:
-
-\hspace{2em}\texttt{./ydiff /tmp/yourfile.mp4 /tmp/yourfile.mp4} 
-
-Since you are comparing a file to itself, you will see a clean looking white window in the left-hand corner and columns 2,3,4 will be all zeros. \ Run this same command with a 3rd spacing parameter of {}-1 as shown below, and you will see artifacts of comparing 2 files starting in a different position.
+You can now use this to check the quality differences of various
+outputs. For example, in this same directory key in:
+% The indentation of an environment matches the type area.
+\begin{list}{}{}
+\item \texttt{./ydiff /tmp/yourfile.mp4 /tmp/yourfile.mp4}
+\end{list}
+%\hspace{2em}\texttt{./ydiff /tmp/yourfile.mp4 /tmp/yourfile.mp4}
 
-\hspace{2em}\texttt{./ydiff /tmp/yourfile.mp4 /tmp/yourfile.mp4 -1}
+Since you are comparing a file to itself, you will see a clean looking white window in the left-hand corner and columns 2,3,4 will be all zeros. Run this same command with a 3rd spacing parameter of {}-1 as shown below, and you will see artifacts of comparing 2 files starting in a different position.
+\begin{list}{}{}
+\item \texttt{./ydiff /tmp/yourfile.mp4 /tmp/yourfile.mp4 -1}
+\end{list}
+% \hspace{2em}\texttt{./ydiff /tmp/yourfile.mp4 /tmp/yourfile.mp4 -1}
 
 Now render yourfile using different quality levels and run ydiff to compare the 2 results. You will see only noise difference which accounts for the quality level. Columns 2,3,4 might no longer be exactly zero but will represent only noise differences. The ydiff output is debug data with lines that show frame size in bytes, sum of error, and sum of absolute value of error. The frames size is sort of useless, the sum of error shows frame gray point drift and the abs error is the total linear color error between the images. At the very end is the total gray point drift and total absolute error on the last line.
 
-{                                      % uses braces to localize caption alignment changes.
-\begin{figure}
-       \captionsetup{justification=raggedright,singlelinecheck=false}
-       \includegraphics[width=0.4\linewidth]{ydiff_same.png}
-       \caption{Exact match}
-       \vspace{-9cm}
-       \hspace{0.4\linewidth}
-       \captionsetup{justification=raggedleft,singlelinecheck=false}
-       \includegraphics[width=0.4\linewidth]{ydiff_change.png}
-       \caption{"giraffe" artifacts on 2 files spaced differently}
-\end{figure}
-}
 
 \section{Image Sequence Creation}
 \label{sec:image_sequence_creation}
+\index{image sequence}
 
 Example script to create a jpeglist sequence file is next:
-
 \begin{lstlisting}[numbers=none]
 #!/bin/bash
 out="$1"
-dir=`dirname "$out"`
+dir=$(dirname "$out")
 shift
-geom=`jpegtopnm "$1" | head -2 | tail -1`
-w=`(set - $geom; echo $1)`
-h=`(set - $geom; echo $2)`
+geom=$(jpegtopnm "$1" | head -2 | tail -1)
+w="$(echo $geom | cut -d " " -f1)"
+h="$(echo $geom | cut -d " " -f2)"
 exec > $out
 echo "JPEGLIST"
 echo "# First line is always JPEGLIST"
@@ -53,87 +80,24 @@ echo "# Height:"
 echo "$h"
 echo "# List of image files follows"
 while [ $# -gt 0 ]; do
-if [ x`dirname "$1"` = x"$dir" ]; then f=./`basename "$1"`; else f="$1"; fi
-echo "$f"
-shift
+  if [ x$(dirname "$1") = x"$dir" ]; then
+       f=./`basename "$1"`;
+  else
+       f="$1";
+  fi
+  echo "$f"
+  shift
 done
 \end{lstlisting}
-
+To use this script, you will have to install the package on your operating system that
+includes \textit{jpegtopnm} which is ususally \textit{netpbm}.
 Example usage of this script follows:
 
 \qquad \texttt{jpeglist.sh outfile infiles*.jpg}
 
-\section{Webm / Vp9 Usage and Example File\protect\footnote{credit Frederic Roenitz}}
-\label{sec:webm/vp9_usage_example}
-
-There are some common VP9 rendering options files that support creation of video for YouTube, Dailymotion, and other online video services. Webm / VP9 is a media file format which is free to use under the BSD license and is open-source; thus there are no licensing issues to be concerned about. The Webm container is based on Matroska for video and Opus for audio.
-
-Youtube easy startup steps are documented in the Appendix (\ref{sec:youtube_with_cinelerra}). These same steps have been verified to work for creating Dailymotion videos -- however, the created files must be renamed before uploading to change the youtube extension to webm instead for Dailymotion.
-
-Below is one of the VP9 rendering options file with documentation for specifics:
-
-\textbf{webm libvpx-vp9}
-
-(20171114-2203)
-
-from {\small \url{https://developers.google.com/media/vp9/settings/vod/}}
-
-1280x720 (24, 25 or 30 frames per second)
-
-Bitrate (bit rate)
-
-VP9 supports several different bitrate modes:
-
-\textit{mode:}
-
-\begin{tabular}{p{6cm} p{10cm}}
-       Constant Quantizer (Q) & Allows you to specify a fixed quantizer value; bitrate will vary \\
-       Constrained Quality (CQ) & Allows you to set a maximum quality level. Quality may vary within bitrate parameters\\
-       Variable Bitrate (VBR) & Balances quality and bitrate over time within constraints on bitrate\\
-       Constant Bitrate (CBR) & Attempts to keep the bitrate fairly constant while quality varies\\
-\end{tabular}
-
-CQ mode is recommended for file-based video (as opposed to streaming). The following FFMpeg command-line parameters are used for CQ mode:
-
-\textit{FFMpeg}:
-
-\begin{center}
-       \begin{tabular}{{p{4cm} p{10cm}}}
-       -b:v <arg> & Sets target bitrate (e.g. 500k)\\
-       -minrate <arg> & Sets minimum bitrate.\\
-       -maxrate <arg> & Sets maximum bitrate.\\
-       -crf <arg> & sets maximum quality level. Valid values are 0-63, lower numbers are higher quality.\\
-\end{tabular}
-\end{center}
-
-\textit{Note 1}: Bitrate is specified in kbps, or kilobits per second. In video compression a kilobit is generally assumed to be 1000 bits (not 1024).
-
-\textit{Note 2:} Other codecs in FFMpeg accept the \textit{-crf} parameter but may interpret the value differently. If you are using \textit{-crf} with other codecs you will likely use different values for VP9.
-
-\texttt{bitrate=1024k}\\
-\texttt{minrate=512k}\\
-\texttt{maxrate=1485k}\\
-\texttt{crf=32}
-
-\textit{Tiling} splits the video into rectangular regions, which allows multi-threading for encoding and decoding. The number of tiles is always a power of two. 0=1 tile; 1=2; 2=4; 3=8; 4=16; 5=32\\
-\texttt{tile-columns=2}
-
-(modified from {\small \url{https://trac.ffmpeg.org/wiki/EncodingForStreamingSites}})
-
-To use a 2 second \textit{GOP} (Group of Pictures), simply multiply your output frame rate $\times$ 2. For example, if your input is \textit{-framerate 30}, then use \textit{-g 60}.\\
-\texttt{g=240}
-
-number of \textit{threads} to use during encoding\\
-\texttt{threads=8}
-
-\textit{Quality} may be set to good, best, or realtime\\
-\texttt{quality=good}
-
-\textit{Speed}: this parameter has different meanings depending upon whether quality is set to good or realtime. Speed settings 0-4 apply for VoD in good and best, with 0 being the highest quality and 4 being the lowest. Realtime valid values are 5-8; lower numbers mean higher quality\\
-\texttt{speed=4}
-
 \section{Details about .bcast5 Files}
 \label{sec:details_.bcast5_files}
+\index{.bcast5}
 
 The following extensions of files in \CGG{}'s \texttt{.bcast5} directory are explained below.
 
@@ -152,3 +116,7 @@ The following extensions of files in \CGG{}'s \texttt{.bcast5} directory are exp
        \item [.png] thumbnails of files in Resources so they do not have to be created over and over
 \end{labeling}
 
+%%% Local Variables:
+%%% mode: latex
+%%% TeX-master: "../CinelerraGG_Manual"
+%%% End: