doc/Vorbis_I_spec.tex

   1 % $Id$
   2 \documentclass[12pt,paper=a4]{scrartcl}
   3
   4 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
   5 % Packages
   6 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
   7
   8 % ...
   9 %\usepackage[margin=3cm]{geometry}
  10 \usepackage{a4wide}
  11
  12 % ...
  13 \usepackage[english]{babel}
  14
  15 %\usepackage[latin1]{inputenc}
  16 %\usepackage[T1]{fontenc}
  17
  18 % Do not indent paragraphs, instead separate them via vertical spacing
  19 \usepackage{parskip}
  20
  21 % Support for graphics, provides \includegraphics
  22 \usepackage{graphicx}
  23 %\graphicspath{{images/}}       % Specify subdir containing the images
  24
  25 % Hyperref enriches the generated PDF with clickable links,
  26 % and provides many other useful features.
  27 \usepackage{nameref}
  28 \usepackage[colorlinks]{hyperref}
  29 \def\sectionautorefname{Section}        % Write section with capital 'S'
  30 \def\subsectionautorefname{Subsection}  % Write subsection with capital 'S'
  31
  32
  33 % The fancyvrb package provides the "Verbatim" environment, which,
  34 % unlike the built-in "verbatim", allows embedding TeX commands, as
  35 % well as tons of other neat stuff (line numbers, formatting adjustments, ...)
  36 \usepackage{fancyvrb}
  37 \fvset{tabsize=4,fontsize=\scriptsize,numbers=left}
  38
  39 % Normally, one can not use the underscore character in LaTeX without
  40 % escaping it (\_ instead of _). Since the Vorbis specs use it a lot,
  41 % we use the underscore package to change this default behavior.
  42 \usepackage[nohyphen]{underscore}
  43
  44 \usepackage{enumitem}
  45
  46 % In LaTeX, pictures are normally put into floating environments, and it is
  47 % left to the typesetting engine to place them in the "optimal" spot. These
  48 % docs however expect pictures to be placed in a *specific* position. So we
  49 % don't use \begin{figure}...\end{figure}, but rather a center environment.
  50 % To still be able to use captions, we use the capt-of package.
  51 \usepackage{capt-of}
  52
  53
  54 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  55 % Custom commands
  56 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  57
  58 % Custom ref command, using hyperrefs autoref & nameref, to simulate the
  59 % behavior of DocBook's '<xref>'.
  60 \newcommand{\xref}[1]{\autoref{#1}, ``\nameref{#1}''}
  61
  62 % Emulat DocBook's '<link>'.
  63 \newcommand{\link}[2]{\hyperref[#1]{#2}}
  64
  65 % Simple 'Note' environment. Can be customized later on.
  66 \newenvironment{note}{\subparagraph*{Note:}}{}
  67
  68 % Map DocBook's <programlisting> to fancyvrb's Verbatim environment
  69 \let\programlisting\Verbatim
  70 \let\endprogramlisting\endVerbatim
  71
  72 % Fake some more DocBook elements
  73 \newcommand{\function}[1]{\texttt{#1}}
  74 \newcommand{\filename}[1]{\texttt{#1}}
  75 \newcommand{\varname}[1]{\texttt{#1}}
  76 \newcommand{\literal}[1]{\texttt{#1}}
  77
  78 % Redefine \~ to generate something that looks more appropriate when used in text.
  79 \renewcommand{\~}{$\sim$}
  80
  81 % Useful helper macro that inserts TODO comments very visibly into the generated
  82 % file. Helps you to not forget to resolve those TODOs... :)
  83 \newcommand{\TODO}[1]{\textcolor{red}{*** #1 ***}}
  84
  85 % Configure graphics formats: Prefer PDF, fall back to PNG or JPG, as available.
  86 \DeclareGraphicsExtensions{.pdf,.png,.jpg,.jpeg}
  87
  88
  89 % NOTE: Things to watch out for: Some chars are reserved in LaTeX. You need to translate them...
  90 %   ~ -> $\sim$ (or \~ which we defined above)
  91 %   % -> \%
  92 %   & -> \&
  93 %   < -> $<$
  94 %   > -> $>$
  95 % and others. Refer to any of the many LaTeX refs out there if in doubt!
  96
  97 \begin{document}
  98
  99
 100 \title{Vorbis I specification}
 101 \author{Xiph.Org Foundation}
 102 \maketitle
 103
 104 \tableofcontents
 105
 106 \include{01-introduction}
 107 \include{02-bitpacking}
 108 \include{03-codebook}
 109 \include{04-codec}
 110 \include{05-comment}
 111 \include{06-floor0}
 112 \include{07-floor1}
 113 \include{08-residue}
 114 \include{09-helper}
 115 \include{10-tables}
 116
 117 \appendix
 118 \include{a1-encapsulation-ogg}
 119 \include{a2-encapsulation-rtp}
 120
 121 \include{footer}
 122
 123
 124 % TODO: Use a bibliography, as in the example below?
 125 \begin{thebibliography}{99}
 126
 127 \bibitem{Sporer/Brandenburg/Edler} T.~Sporer, K.~Brandenburg and B.~Edler,
 128 The use of multirate filter banks for coding of high quality digital audio,
 129 \url{http://www.iocon.com/resource/docs/ps/eusipco_corrected.ps}.
 130
 131
 132 \end{thebibliography}
 133
 134 \end{document}