Docbook to latex conversion of the spec by Max Horn.
[platform/upstream/libvorbis.git] / doc / Vorbis_I_spec.tex
1 % $Id$
2 % latex2html -show_section_numbers -split 0 -html_version 4.0 Vorbis_I_spec.tex
3 %\documentclass[a4paper]{article}
4 \documentclass[a4paper]{scrartcl}
5 %\documentclass[twoside,idxtotoc,bibtotoc,a4paper,12pt,BCOR12mm,DIV13]{scrbook}
6
7 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
8 % Packages
9 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
10
11 % ...
12 %\usepackage[margin=3cm]{geometry}
13 \usepackage{a4wide}
14
15 % ...
16 \usepackage{enumitem}
17
18 % ...
19 \usepackage[english]{babel}
20
21 %\usepackage[latin1]{inputenc}
22 %\usepackage[T1]{fontenc}
23
24 % Do not indent paragraphs, instead separate them via vertical spacing
25 \usepackage{parskip}
26
27 % Support for graphics, provides \includegraphics
28 \usepackage{graphicx}
29 %\graphicspath{{images/}}       % Specify subdir containing the images
30
31 % Hyperref enriches the generated PDF with clickable links,
32 % and provides many other useful features.
33 \usepackage{hyperref}
34 %\usepackage[colorlinks]{hyperref}
35 %\usepackage[pdfborder={0 0 0}]{hyperref}
36 \def\sectionautorefname{Section}        % Write section with capital 'S'
37 \def\subsectionautorefname{Subsection}  % Write subsection with capital 'S'
38
39
40 % provides the 'comment' env, which is useful to temporarily comment out a block of code
41 \usepackage{verbatim}
42
43 % ...
44 %\usepackage{listings}
45 %\lstset{language=Pascal} 
46
47 % The fancyvrb package provides the "Verbatim" environment, which,
48 % unlike the built-in "verbatim", allows embedding TeX commands, as
49 % well as tons of other neat stuff (line numbers, formatting adjustments, ...)
50 \usepackage{fancyvrb}
51 %\fvset{tabsize=4,fontsize=\scriptsize,numbers=left}
52 \fvset{tabsize=4,fontsize=\small}
53 %\fvset{tabsize=4}
54
55 % ...
56 \usepackage{color}      % Colored text, used for \TODO macro
57
58 % ...
59 \usepackage[nohyphen]{underscore}
60
61 % ...
62 \usepackage{capt-of}
63
64 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
65 % Custom commands
66 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
67
68 % Custom ref command, using hyperrefs autoref & nameref, to simulate the 
69 % behavior of DocBooks's 'xref'.
70 \newcommand{\xref}[1]{\autoref{#1}, ``\nameref{#1}''}
71
72 %...
73 \newcommand{\link}[2]{\hyperref[#1]{#2}}
74
75 % Redefine \~ to generate something that looks more appropriate when used in text.
76 \renewcommand{\~}{$\sim$}
77
78 % ...
79 \newenvironment{note}{\subparagraph*{Note:}}{}
80
81 % ...
82 \let\programlisting\Verbatim
83 \let\endprogramlisting\endVerbatim
84
85 % ...
86 \newcommand{\function}[1]{\texttt{#1}}
87 \newcommand{\filename}[1]{\texttt{#1}}
88 \newcommand{\varname}[1]{\texttt{#1}}
89 \newcommand{\literal}[1]{\texttt{#1}}
90
91 % ...
92 \newcommand{\TODO}[1]{\textcolor{red}{*** #1 ***}}
93 \newcommand{\NOTE}[1]{\textcolor{blue}{*** #1 ***}}
94
95 \DeclareGraphicsExtensions{.pdf,.png}
96
97
98 % TODO/FIXME: Things to watch out for:
99 % - Translate some chars: ~ -> $\sim$,  % -> \%, & -> \&, ...
100
101 \begin{document}
102
103
104 \title{Vorbis I specification}
105 \author{Xiph.org Foundation}
106 \maketitle
107
108 \tableofcontents
109
110 \include{01-introduction}
111 \include{02-bitpacking}
112 \include{03-codebook}
113 \include{04-codec}
114 \include{05-comment}
115 \include{06-floor0}
116 \include{07-floor1}
117 \include{08-residue}
118 \include{09-helper}
119 \include{10-tables}
120
121 \appendix
122 \include{a1-encapsulation-ogg}
123 \include{a2-encapsulation-rtp}
124
125 \include{footer}
126
127  
128 % TODO: Use a bibliography, as in the example below?
129 \begin{thebibliography}{99} 
130  
131 \bibitem{Sporer/Brandenburg/Edler} T.~Sporer, K.~Brandenburg and B.~Edler, 
132 The use of multirate filter banks for coding of high quality digital audio,
133 \url{http://www.iocon.com/resource/docs/ps/eusipco_corrected.ps}.
134
135
136 \end{thebibliography}
137
138 \end{document}