annotate src/libvorbis-1.3.3/doc/Vorbis_I_spec.tex @ 56:af97cad61ff0

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