parts/AuxilaryPrograms.tex

   1 \chapter{Auxiliary Programs}%
   2 \label{cha:auxiliary_programs}
   3
   4 \section{Using Ydiff to check results}
   5 \label{sec:ydiff_check_results}
   6
   7 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}.
   8
   9 You can now use this to check the quality differences of various outputs. \ For example, in this same directory key in:
  10
  11 \hspace{2em}\texttt{./ydiff /tmp/yourfile.mp4 /tmp/yourfile.mp4}
  12
  13 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.
  14
  15 \hspace{2em}\texttt{./ydiff /tmp/yourfile.mp4 /tmp/yourfile.mp4 -1}
  16
  17 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.
  18
  19 {                                       % uses braces to localize caption alignment changes.
  20 \begin{figure}
  21         \captionsetup{justification=raggedright,singlelinecheck=false}
  22         \includegraphics[width=0.4\linewidth]{ydiff_same.png}
  23         \caption{Exact match}
  24         \vspace{-9cm}
  25         \hspace{0.4\linewidth}
  26         \captionsetup{justification=raggedleft,singlelinecheck=false}
  27         \includegraphics[width=0.4\linewidth]{ydiff_change.png}
  28         \caption{"giraffe" artifacts on 2 files spaced differently}
  29 \end{figure}
  30 }
  31
  32 \section{Image Sequence Creation}
  33 \label{sec:image_sequence_creation}
  34
  35 Example script to create a jpeglist sequence file is next:
  36
  37 \begin{lstlisting}[numbers=none]
  38 #!/bin/bash
  39 out="$1"
  40 dir=`dirname "$out"`
  41 shift
  42 geom=`jpegtopnm "$1" | head -2 | tail -1`
  43 w=`(set - $geom; echo $1)`
  44 h=`(set - $geom; echo $2)`
  45 exec > $out
  46 echo "JPEGLIST"
  47 echo "# First line is always JPEGLIST"
  48 echo "# Frame rate:"
  49 echo "29.970030"
  50 echo "# Width:"
  51 echo "$w"
  52 echo "# Height:"
  53 echo "$h"
  54 echo "# List of image files follows"
  55 while [ $# -gt 0 ]; do
  56 if [ x`dirname "$1"` = x"$dir" ]; then f=./`basename "$1"`; else f="$1"; fi
  57 echo "$f"
  58 shift
  59 done
  60 \end{lstlisting}
  61
  62 Example usage of this script follows:
  63
  64 \qquad \texttt{jpeglist.sh outfile infiles*.jpg}
  65
  66 \section{Webm / Vp9 Usage and Example File\protect\footnote{credit Frederic Roenitz}}
  67 \label{sec:webm/vp9_usage_example}
  68
  69 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.
  70
  71 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.
  72
  73 Below is one of the VP9 rendering options file with documentation for specifics:
  74
  75 \textbf{webm libvpx-vp9}
  76
  77 (20171114-2203)
  78
  79 from {\small \url{https://developers.google.com/media/vp9/settings/vod/}}
  80
  81 1280x720 (24, 25 or 30 frames per second)
  82
  83 Bitrate (bit rate)
  84
  85 VP9 supports several different bitrate modes:
  86
  87 \textit{mode:}
  88
  89 \begin{tabular}{p{6cm} p{10cm}}
  90         Constant Quantizer (Q) & Allows you to specify a fixed quantizer value; bitrate will vary \\
  91         Constrained Quality (CQ) & Allows you to set a maximum quality level. Quality may vary within bitrate parameters\\
  92         Variable Bitrate (VBR) & Balances quality and bitrate over time within constraints on bitrate\\
  93         Constant Bitrate (CBR) & Attempts to keep the bitrate fairly constant while quality varies\\
  94 \end{tabular}
  95
  96 CQ mode is recommended for file-based video (as opposed to streaming). The following FFMpeg command-line parameters are used for CQ mode:
  97
  98 \textit{FFMpeg}:
  99
 100 \begin{center}
 101         \begin{tabular}{{p{4cm} p{10cm}}}
 102         -b:v <arg> & Sets target bitrate (e.g. 500k)\\
 103         -minrate <arg> & Sets minimum bitrate.\\
 104         -maxrate <arg> & Sets maximum bitrate.\\
 105         -crf <arg> & sets maximum quality level. Valid values are 0-63, lower numbers are higher quality.\\
 106 \end{tabular}
 107 \end{center}
 108
 109 \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).
 110
 111 \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.
 112
 113 \texttt{bitrate=1024k}\\
 114 \texttt{minrate=512k}\\
 115 \texttt{maxrate=1485k}\\
 116 \texttt{crf=32}
 117
 118 \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\\
 119 \texttt{tile-columns=2}
 120
 121 (modified from {\small \url{https://trac.ffmpeg.org/wiki/EncodingForStreamingSites}})
 122
 123 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}.\\
 124 \texttt{g=240}
 125
 126 number of \textit{threads} to use during encoding\\
 127 \texttt{threads=8}
 128
 129 \textit{Quality} may be set to good, best, or realtime\\
 130 \texttt{quality=good}
 131
 132 \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\\
 133 \texttt{speed=4}
 134
 135 \section{Details about .bcast5 Files}
 136 \label{sec:details_.bcast5_files}
 137
 138 The following extensions of files in \CGG{}'s \texttt{.bcast5} directory are explained below.
 139
 140 % Labeling requires a parameter with the longest word of the labels.
 141 \begin{labeling}{ladspa\_plugins{\dots}}
 142         \item [.dat] represent saved \textit{data} for perpertual sessions and color palettes; maybe others
 143         \item [.idx] original \textit{index} files that were created for loaded video to speed up seeking
 144         \item [.mkr] ffmpeg specific \textit{marker} index file that is created for each video to aid seeks
 145         \item [.rc] rc stands for \textit{run commands} so basically represents a script
 146         \item [.toc] toc is \textit{table of contents} file for MPEG video files (a type of index)
 147         \item [Cinelerra\_plugins] a list of the currently loaded plugins available in your \CGG{} session
 148         \item [Cinelerra{}\_rc] the user's preferences and settings are saved in this file to be used on startup
 149         \item [ladspa\_plugins{\dots}] list of currently loaded ladspa plugins for each version of \CGG{} being used
 150         \item [layout\#...\_rc] user-defined window layout setup with the layout name as part of the file name
 151         \item [.xml] used for various backups or for the current settings of plugins that you have used
 152         \item [.png] thumbnails of files in Resources so they do not have to be created over and over
 153 \end{labeling}
 154