test/README.tex

   1 \documentclass{article}
   2 \newcommand{\co}[1]{\texttt{#1}}
   3 \begin{document}
   4
   5 \section{DCP-o-matic unit tests}
   6
   7 The files in this directory can be grouped roughly into the following:
   8
   9 \subsection{Self-contained tests of single classes / method sets}
  10
  11 \begin{tabular}{|l|l|}
  12   \hline
  13   \textbf{Class / source file} & \textbf{File} \\
  14   \hline
  15   \co{AudioAnalysis} & \co{audio\_analysis\_test} \\
  16   \hline
  17   \co{AudioBuffers} & \co{audio\_buffers\_test} \\
  18   \hline
  19   \co{AudioMapping} & \co{audio\_mapping\_test} \\
  20   \hline
  21   \co{AudioMerger} & \co{audio\_merger\_test} \\
  22   \hline
  23   \co{AudioFilter} & \co{audio\_filter\_test} \\
  24   \hline
  25   \co{ColourConversion} & \co{colour\_conversion\_test} \\
  26   \hline
  27   \co{FileGroup} & \co{file\_group\_test} \\
  28   \hline
  29   \co{Image} & \co{image\_test}, \co{pixel\_formats\_test}, \co{make\_black\_test} \\
  30   \hline
  31   \co{Player} & \co{player\_test} \\
  32   \hline
  33   \co{Job/JobManager} & \co{job\_test} \\
  34   \hline
  35   \co{Ratio} & \co{ratio\_test} \\
  36   \hline
  37   \co{Resampler} & \co{resampler\_test} \\
  38   \hline
  39   \co{util.cc} & \co{util\_test} \\
  40   \hline
  41 \end{tabular}
  42
  43 \subsection{``Complete'' builds of DCPs with various characteristics, aiming to test broad areas of code}
  44
  45 \begin{itemize}
  46   \item \co{4k\_test}
  47   \item \co{threed\_test}
  48   \item \co{torture\_test}
  49 \end{itemize}
  50
  51 \subsection{Tests of fairly specific areas}
  52
  53 \begin{tabular}{|l|p{8cm}|}
  54   \hline
  55   \textbf{File} & \textbf{Test summary} \\
  56   \hline
  57   \co{audio\_delay\_test} & Some FFmpeg content with audio delays. \\
  58   \hline
  59   \co{client\_server\_test} & An encode server running on \co{localhost}. \\
  60   \hline
  61   \co{digest\_test} & Computed DCP digests compared to those calculated by the \co{openssl} binary. \\
  62   \hline
  63   \co{film\_metadata\_test} & Read/write of \co{Film} metadata. \\
  64   \hline
  65   \co{frame\_rate\_test} & Frame rate conversion calculations. \\
  66   \hline
  67   \co{recover\_test} & Re-making a DCP when a previous run was interrupted. \\
  68   \hline
  69   \co{repeat\_frame\_test} & Repetition of 24fps content in a 48fps DCP. \\
  70   \hline
  71   \co{scaling\_test} & Scaling and black-padding of images. \\
  72   \hline
  73   \co{silence\_padding\_test} & \\
  74   \hline
  75   \co{skip\_frame\_test} & \\
  76   \hline
  77 \end{tabular}
  78
  79 \subsubsection{FFmpeg decoding}
  80
  81 \begin{itemize}
  82 \item \co{ffmpeg\_audio\_test}
  83 \item \co{ffmpeg\_dcp\_test}
  84 \item \co{ffmpeg\_decoder\_seek\_test}
  85 \item \co{ffmpeg\_decoder\_sequential\_test}
  86 \item \co{ffmpeg\_examiner\_test}
  87 \item \co{ffmpeg\_pts\_offset\_test}
  88 \item \co{stream\_test}
  89 \end{itemize}
  90
  91 \co{test/audio\_processor\_delay\_test.cc}
  92 \co{test/audio\_processor\_test.cc}
  93 \co{test/burnt\_subtitle\_test.cc}
  94 \co{test/dcpomatic\_time\_test.cc}
  95 \co{test/dcp\_subtitle\_test.cc}
  96 \co{test/ffmpeg\_audio\_only\_test.cc}
  97 \co{test/file\_log\_test.cc}
  98 \co{test/file\_naming\_test.cc}
  99 \co{test/image\_filename\_sorter\_test.cc}
 100 \co{test/import\_dcp\_test.cc}
 101 \co{test/interrupt\_encoder\_test.cc}
 102 \co{test/isdcf\_name\_test.cc}
 103 \co{test/j2k\_bandwidth\_test.cc}
 104 \co{test/rect\_test.cc}
 105 \co{test/reels\_test.cc}
 106 \co{test/render\_subtitles\_test.cc}
 107 \co{test/required\_disk\_space\_test.cc}
 108 \co{test/srt\_subtitle\_test.cc}
 109 \co{test/ssa\_subtitle\_test.cc}
 110 \co{test/test.cc}
 111 \co{test/time\_calculation\_test.cc}
 112 \co{test/update\_checker\_test.cc}
 113 \co{test/upmixer\_a\_test.cc}
 114 \co{test/vf\_kdm\_test.cc}
 115 \co{test/vf\_test.cc}
 116 \co{test/video\_content\_scale\_test.cc}
 117 \co{test/video\_mxf\_content\_test.cc}
 118
 119 \end{document}