fixes error in definition of V(N,K)
[opus.git] / doc / draft-ietf-codec-opus.xml
1 <?xml version='1.0'?>
2 <!DOCTYPE rfc SYSTEM 'rfc2629.dtd'>
3 <?rfc toc="yes" symrefs="yes" ?>
4
5 <rfc ipr="trust200902" category="std" docName="draft-ietf-codec-opus-03">
6
7 <front>
8 <title abbrev="Interactive Audio Codec">Definition of the Opus Audio Codec</title>
9
10
11 <author initials="JM" surname="Valin" fullname="Jean-Marc Valin">
12 <organization>Octasic Inc.</organization>
13 <address>
14 <postal>
15 <street>4101, Molson Street</street>
16 <city>Montreal</city>
17 <region>Quebec</region>
18 <code></code>
19 <country>Canada</country>
20 </postal>
21 <phone>+1 514 282-8858</phone>
22 <email>jean-marc.valin@octasic.com</email>
23 </address>
24 </author>
25
26 <author initials="K." surname="Vos" fullname="Koen Vos">
27 <organization>Skype Technologies S.A.</organization>
28 <address>
29 <postal>
30 <street>Stadsgarden 6</street>
31 <city>Stockholm</city>
32 <region></region>
33 <code>11645</code>
34 <country>SE</country>
35 </postal>
36 <phone>+46 855 921 989</phone>
37 <email>koen.vos@skype.net</email>
38 </address>
39 </author>
40
41
42 <date day="15" month="February" year="2011" />
43
44 <area>General</area>
45
46 <workgroup></workgroup>
47
48 <abstract>
49 <t>
50 This document describes the Opus codec, designed for interactive speech and audio 
51 transmission over the Internet.
52 </t>
53 </abstract>
54 </front>
55
56 <middle>
57
58 <section anchor="introduction" title="Introduction">
59 <t>
60 We propose the Opus codec based on a linear prediction layer (LP) and an
61 MDCT-based enhancement layer. The main idea behind the proposal is that
62 the speech low frequencies are usually more efficiently coded using
63 linear prediction codecs (such as CELP variants), while the higher frequencies
64 are more efficiently coded in the transform domain (e.g. MDCT). For low 
65 sampling rates, the MDCT layer is not useful and only the LP-based layer is
66 used. On the other hand, non-speech signals are not always adequately coded
67 using linear prediction, so for music only the MDCT-based layer is used.
68 </t>
69
70 <t>
71 In this proposed prototype, the LP layer is based on the 
72 <eref target='http://developer.skype.com/silk'>SILK</eref> codec 
73 <xref target="SILK"></xref> and the MDCT layer is based on the 
74 <eref target='http://www.celt-codec.org/'>CELT</eref>  codec
75  <xref target="CELT"></xref>.
76 </t>
77
78 <t>This is a work in progress.</t>
79 </section>
80
81 <section anchor="hybrid" title="Opus Codec">
82
83 <t>
84 In hybrid mode, each frame is coded first by the LP layer and then by the MDCT 
85 layer. In the current prototype, the cutoff frequency is 8 kHz. In the MDCT
86 layer, all bands below 8 kHz are discarded, such that there is no coding
87 redundancy between the two layers. Also both layers use the same instance of 
88 the range coder to encode the signal, which ensures that no "padding bits" are
89 wasted. The hybrid approach makes it easy to support both constant bit-rate
90 (CBR) and varaible bit-rate (VBR) coding. Although the SILK layer used is VBR,
91 it is easy to make the bit allocation of the CELT layer produce a final stream
92 that is CBR by using all the bits left unused by the SILK layer.
93 </t>
94
95 <t>
96 In addition to their frame size, the SILK and CELT codecs require
97 a look-ahead of 5.2 ms and 2.5 ms, respectively. SILK's look-ahead is due to
98 noise shaping estimation (5 ms) and the internal resampling (0.2 ms), while
99 CELT's look-ahead is due to the overlapping MDCT windows. To compensate for the
100 difference, the CELT encoder input is delayed by 2.7 ms. This ensures that low
101 frequencies and high frequencies arrive at the same time.
102 </t>
103
104
105 <section title="Source Code">
106 <t>
107 The source code is currently available in a
108 <eref target='git://git.xiph.org/users/jm/ietfcodec.git'>Git repository</eref> 
109 which references two other
110 repositories (for SILK and CELT). Development snapshots are provided at 
111 <eref target='http://opus-codec.org/'/>.
112
113 </t>
114 </section>
115
116 </section>
117
118 <section anchor="modes" title="Codec Modes">
119 <t>
120 There are three possible operating modes for the proposed prototype:
121 <list style="numbers">
122 <t>A linear prediction (LP) mode for use in low bit-rate connections with up to 8 kHz audio bandwidth (16 kHz sampling rate)</t>
123 <t>A hybrid (LP+MDCT) mode for full-bandwidth speech at medium bitrates</t>
124 <t>An MDCT-only mode for very low delay speech transmission as well as music transmission.</t>
125 </list>
126 Each of these modes supports a number of difference frame sizes and sampling
127 rates. In order to distinguish between the various modes and configurations,
128 we define a single-byte table-of-contents (TOC) header that can used in the transport layer 
129 (e.g RTP) to signal this information. The following describes the proposed
130 TOC byte.
131 </t>
132
133 <t>
134 The LP mode supports the following configurations (numbered from 0 to 11):
135 <list style="symbols">
136 <t>8 kHz:  10, 20, 40, 60 ms (0..3)</t>
137 <t>12 kHz: 10, 20, 40, 60 ms (4..7)</t>
138 <t>16 kHz: 10, 20, 40, 60 ms (8..11)</t>
139 </list>
140 for a total of 12 configurations.
141 </t>
142
143 <t>
144 The hybrid mode supports the following configurations (numbered from 12 to 15):
145 <list style="symbols">
146 <t>32 kHz: 10, 20 ms (12..13)</t>
147 <t>48 kHz: 10, 20 ms (14..15)</t>
148 </list>
149 for a total of 4 configurations.
150 </t>
151
152 <t>
153 The MDCT-only mode supports the following configurations (numbered from 16 to 31):
154 <list style="symbols">
155 <t>8 kHz:  2.5, 5, 10, 20 ms (16..19)</t>
156 <t>16 kHz: 2.5, 5, 10, 20 ms (20..23)</t>
157 <t>32 kHz: 2.5, 5, 10, 20 ms (24..27)</t>
158 <t>48 kHz: 2.5, 5, 10, 20 ms (28..31)</t>
159 </list>
160 for a total of 16 configurations.
161 </t>
162
163 <t>
164 There is thus a total of 32 configurations, encoded in 5 bits. On bit is used to signal mono vs stereo, which leaves 2 bits for the number of frames per packets (codes 0 to 3):
165 <list style="symbols">
166 <t>0:    1 frames in the packet</t>
167 <t>1:    2 frames in the packet, each with equal compressed size</t>
168 <t>2:    2 frames in the packet, with different compressed size</t>
169 <t>3:    arbitrary number of frames in the packet</t>
170 </list>
171 For code 2, the TOC byte is followed by the length of the first frame, encoded as described below.
172 For code 3, the TOC byte is followed by a byte encoding the number of frames in the packet, with the MSB indicating VBR. In the VBR case, the byte indicating the number of frames is followed by N-1 frame 
173 lengths encoded as described below. As an additional limit, the audio duration contained
174 within a packet may not exceed 120 ms.
175 </t>
176
177 <t>
178 The compressed size of the frames (if needed) is indicated -- usually -- with one byte, with the following meaning:
179 <list style="symbols">
180 <t>0:          No frame (DTX or lost packet)</t>
181 <t>1-251:      Size of the frame in bytes</t>
182 <t>252-255:    A second byte is needed. The total size is (size[1]*4)+size[0]</t>
183 </list>
184 </t>
185
186 <t>
187 The maximum size representable is 255*4+255=1275 bytes. For 20 ms frames, that 
188 represents a bit-rate of 510 kb/s, which is really the highest rate anyone would want 
189 to use in stereo mode (beyond that point, lossless codecs would be more appropriate).
190 </t>
191
192 <section anchor="examples" title="Examples">
193 <t>
194 Simplest case: one narrowband mono 20-ms SILK frame
195 </t>
196
197 <t>
198 <figure>
199 <artwork><![CDATA[
200  0                   1                   2                   3
201  0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
202 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
203 |    1    |0|0|0|               compressed data...              |
204 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
205 ]]></artwork>
206 </figure>
207 </t>
208
209 <t>
210 Two 48 kHz mono 5 ms CELT frames of the same compressed size:
211 </t>
212
213 <t>
214 <figure>
215 <artwork><![CDATA[
216  0                   1                   2                   3
217  0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
218 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
219 |    29   |0|0|1|               compressed data...              |
220 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
221 ]]></artwork>
222 </figure>
223 </t>
224
225 <t>
226 Two 48 kHz mono 20-ms hybrid frames of different compressed size:
227 </t>
228
229 <t>
230 <figure>
231 <artwork><![CDATA[
232  0                   1                   2                   3
233  0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
234 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
235 |    15   |0|1|1|       2       |   frame size  |compressed data|
236 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
237 |                       compressed data...                      |
238 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
239 ]]></artwork>
240 </figure>
241 </t>
242
243 <t>
244 Four 48 kHz stereo 20-ms CELT frame of the same compressed size:
245
246 </t>
247
248 <t>
249 <figure>
250 <artwork><![CDATA[
251  0                   1                   2                   3
252  0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
253 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
254 |    31   |1|1|0|       4       |      compressed data...       |
255 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
256 ]]></artwork>
257 </figure>
258 </t>
259 </section>
260
261
262 </section>
263
264 <section title="Opus Decoder">
265 <t>
266 The Opus decoder consists of two main blocks: the SILK decoder and the CELT decoder. 
267 The output of the Opus decode is the sum of the outputs from the SILK and CELT decoders
268 with proper sample rate conversion and delay compensation as illustrated in the
269 block diagram below. At any given time, one or both of the SILK and CELT decoders
270 may be active. 
271 <figure>
272 <artwork>
273 <![CDATA[
274                        +-------+    +----------+
275                        | SILK  |    |  sample  |
276                     +->|encoder|--->|   rate   |----+
277 bit-    +-------+   |  |       |    |conversion|    v
278 stream  | Range |---+  +-------+    +----------+  /---\  audio
279 ------->|decoder|                                 | + |------>
280         |       |---+  +-------+    +----------+  \---/
281         +-------+   |  | CELT  |    | Delay    |    ^
282                     +->|decoder|----| compens- |----+
283                        |       |    | ation    |
284                        +-------+    +----------+
285 ]]>
286 </artwork>
287 </figure>
288 </t>
289
290 <section anchor="range-decoder" title="Range Decoder">
291 <t>
292 The range decoder extracts the symbols and integers encoded using the range encoder in
293 <xref target="range-encoder"></xref>. The range decoder maintains an internal
294 state vector composed of the two-tuple (dif,rng), representing the
295 difference between the high end of the current range and the actual
296 coded value, and the size of the current range, respectively. Both
297 dif and rng are 32-bit unsigned integer values. rng is initialized to
298 2^7. dif is initialized to rng minus the top 7 bits of the first
299 input octet. Then the range is immediately normalized, using the
300 procedure described in the following section.
301 </t>
302
303 <section anchor="decoding-symbols" title="Decoding Symbols">
304 <t>
305    Decoding symbols is a two-step process. The first step determines
306    a value fs that lies within the range of some symbol in the current
307    context. The second step updates the range decoder state with the
308    three-tuple (fl,fh,ft) corresponding to that symbol, as defined in
309    <xref target="encoding-symbols"></xref>.
310 </t>
311 <t>
312    The first step is implemented by ec_decode() 
313    (rangedec.c), 
314    and computes fs = ft-min((dif-1)/(rng/ft)+1,ft), where ft is
315    the sum of the frequency counts in the current context, as described
316    in <xref target="encoding-symbols"></xref>. The divisions here are exact integer division. 
317 </t>
318 <t>
319    In the reference implementation, a special version of ec_decode()
320    called ec_decode_bin() (rangeenc.c) is defined using
321    the parameter ftb instead of ft. It is mathematically equivalent to
322    calling ec_decode() with ft = (1&lt;&lt;ftb), but avoids one of the
323    divisions.
324 </t>
325 <t>
326    The decoder then identifies the symbol in the current context
327    corresponding to fs; i.e., the one whose three-tuple (fl,fh,ft)
328    satisfies fl &lt;= fs &lt; fh. This tuple is used to update the decoder
329    state according to dif = dif - (rng/ft)*(ft-fh), and if fl is greater
330    than zero, rng = (rng/ft)*(fh-fl), or otherwise rng = rng - (rng/ft)*(ft-fh). After this update, the range is normalized.
331 </t>
332 <t>
333    To normalize the range, the following process is repeated until
334    rng > 2^23. First, rng is set to (rng&lt;8)&amp;0xFFFFFFFF. Then the next
335    8 bits of input are read into sym, using the remaining bit from the
336    previous input octet as the high bit of sym, and the top 7 bits of the
337    next octet for the remaining bits of sym. If no more input octets
338    remain, zero bits are used instead. Then, dif is set to
339    (dif&lt;&lt;8)-sym&amp;0xFFFFFFFF (i.e., using wrap-around if the subtraction
340    overflows a 32-bit register). Finally, if dif is larger than 2^31,
341    dif is then set to dif - 2^31. This process is carried out by
342    ec_dec_normalize() (rangedec.c).
343 </t>
344 </section>
345
346 <section anchor="decoding-ints" title="Decoding Uniformly Distributed Integers">
347 <t>
348    Functions ec_dec_uint() or ec_dec_bits() are based on ec_decode() and
349    decode one of N equiprobable symbols, each with a frequency of 1,
350    where N may be as large as 2^32-1. Because ec_decode() is limited to
351    a total frequency of 2^16-1, this is done by decoding a series of
352    symbols in smaller contexts.
353 </t>
354 <t>
355    ec_dec_bits() (entdec.c) is defined, like
356    ec_decode_bin(), to take a single parameter ftb, with ftb &lt; 32.
357    and ftb &lt; 32, and produces an ftb-bit decoded integer value, t,
358    initialized to zero. While ftb is greater than 8, it decodes the next
359    8 most significant bits of the integer, s = ec_decode_bin(8), updates
360    the decoder state with the 3-tuple (s,s+1,256), adds those bits to
361    the current value of t, t = t&lt;&lt;8 | s, and subtracts 8 from ftb. Then
362    it decodes the remaining bits of the integer, s = ec_decode_bin(ftb),
363    updates the decoder state with the 3 tuple (s,s+1,1&lt;&lt;ftb), and adds
364    those bits to the final values of t, t = t&lt;&lt;ftb | s.
365 </t>
366 <t>
367    ec_dec_uint() (entdec.c) takes a single parameter,
368    ft, which is not necessarily a power of two, and returns an integer,
369    t, with a value between 0 and ft-1, inclusive, which is initialized to zero. Let
370    ftb be the location of the highest 1 bit in the two's-complement
371    representation of (ft-1), or -1 if no bits are set. If ftb>8, then
372    the top 8 bits of t are decoded using t = ec_decode((ft-1>>ftb-8)+1),
373    the decoder state is updated with the three-tuple
374    (s,s+1,(ft-1>>ftb-8)+1), and the remaining bits are decoded with
375    t = t&lt;&lt;ftb-8|ec_dec_bits(ftb-8). If, at this point, t >= ft, then
376    the current frame is corrupt, and decoding should stop. If the
377    original value of ftb was not greater than 8, then t is decoded with
378    t = ec_decode(ft), and the decoder state is updated with the
379    three-tuple (t,t+1,ft).
380 </t>
381 </section>
382
383 <section anchor="decoder-tell" title="Current Bit Usage">
384 <t>
385    The bit allocation routines in CELT need to be able to determine a
386    conservative upper bound on the number of bits that have been used
387    to decode from the current frame thus far. This drives allocation
388    decisions which must match those made in the encoder. This is
389    computed in the reference implementation to fractional bit precision
390    by the function ec_dec_tell() (rangedec.c). Like all
391    operations in the range decoder, it must be implemented in a
392    bit-exact manner, and must produce exactly the same value returned by
393    ec_enc_tell() after encoding the same symbols.
394 </t>
395 </section>
396
397 </section>
398
399       <section anchor='outline_decoder' title='SILK Decoder'>
400         <t>
401           At the receiving end, the received packets are by the range decoder split into a number of frames contained in the packet. Each of which contains the necessary information to reconstruct a 20 ms frame of the output signal.
402         </t>
403         <section title="Decoder Modules">
404           <t>
405             An overview of the decoder is given in <xref target="decoder_figure" />.
406             <figure align="center" anchor="decoder_figure">
407               <artwork align="center">
408                 <![CDATA[
409    
410    +---------+    +------------+    
411 -->| Range   |--->| Decode     |---------------------------+
412  1 | Decoder | 2  | Parameters |----------+       5        |
413    +---------+    +------------+     4    |                |
414                        3 |                |                |
415                         \/               \/               \/
416                   +------------+   +------------+   +------------+
417                   | Generate   |-->| LTP        |-->| LPC        |-->
418                   | Excitation |   | Synthesis  |   | Synthesis  | 6
419                   +------------+   +------------+   +------------+
420
421 1: Range encoded bitstream
422 2: Coded parameters
423 3: Pulses and gains
424 4: Pitch lags and LTP coefficients
425 5: LPC coefficients
426 6: Decoded signal
427 ]]>
428               </artwork>
429               <postamble>Decoder block diagram.</postamble>
430             </figure>
431           </t>
432
433           <section title='Range Decoder'>
434             <t>
435               The range decoder decodes the encoded parameters from the received bitstream. Output from this function includes the pulses and gains for the excitation signal generation, as well as LTP and LSF codebook indices, which are needed for decoding LTP and LPC coefficients needed for LTP and LPC synthesis filtering the excitation signal, respectively.
436             </t>
437           </section>
438
439           <section title='Decode Parameters'>
440             <t>
441               Pulses and gains are decoded from the parameters that was decoded by the range decoder.
442             </t>
443
444             <t>
445               When a voiced frame is decoded and LTP codebook selection and indices are received, LTP coefficients are decoded using the selected codebook by choosing the vector that corresponds to the given codebook index in that codebook. This is done for each of the four subframes.
446               The LPC coefficients are decoded from the LSF codebook by first adding the chosen vectors, one vector from each stage of the codebook. The resulting LSF vector is stabilized using the same method that was used in the encoder, see
447               <xref target='lsf_stabilizer_overview_section' />. The LSF coefficients are then converted to LPC coefficients, and passed on to the LPC synthesis filter.
448             </t>
449           </section>
450
451           <section title='Generate Excitation'>
452             <t>
453               The pulses signal is multiplied with the quantization gain to create the excitation signal.
454             </t>
455           </section>
456
457           <section title='LTP Synthesis'>
458             <t>
459               For voiced speech, the excitation signal e(n) is input to an LTP synthesis filter that will recreate the long term correlation that was removed in the LTP analysis filter and generate an LPC excitation signal e_LPC(n), according to
460               <figure align="center">
461                 <artwork align="center">
462                   <![CDATA[
463                    d
464                   __
465 e_LPC(n) = e(n) + \  e(n - L - i) * b_i,
466                   /_
467                  i=-d
468 ]]>
469                 </artwork>
470               </figure>
471               using the pitch lag L, and the decoded LTP coefficients b_i.
472
473               For unvoiced speech, the output signal is simply a copy of the excitation signal, i.e., e_LPC(n) = e(n).
474             </t>
475           </section>
476
477           <section title='LPC Synthesis'>
478             <t>
479               In a similar manner, the short-term correlation that was removed in the LPC analysis filter is recreated in the LPC synthesis filter. The LPC excitation signal e_LPC(n) is filtered using the LTP coefficients a_i, according to
480               <figure align="center">
481                 <artwork align="center">
482                   <![CDATA[
483                  d_LPC
484                   __
485 y(n) = e_LPC(n) + \  e_LPC(n - i) * a_i,
486                   /_
487                   i=1
488 ]]>
489                 </artwork>
490               </figure>
491               where d_LPC is the LPC synthesis filter order, and y(n) is the decoded output signal.
492             </t>
493           </section>
494         </section>
495       </section>
496
497
498 <section title="CELT Decoder">
499
500 <t>
501 Insert decoder figure.
502
503 </t>
504
505 <texttable anchor='table_example'>
506 <ttcol align='center'>Symbol(s)</ttcol>
507 <ttcol align='center'>PDF</ttcol>
508 <ttcol align='center'>Condition</ttcol>
509 <c>silence</c>      <c>[32767, 1]/32768</c> <c></c>
510 <c>post-filter</c>  <c>[1, 1]/2</c> <c></c>
511 <c>octave</c>       <c>uniform (6)</c><c>post-filter</c>
512 <c>period</c>       <c>raw bits (4+octave)</c><c>post-filter</c>
513 <c>gain</c>         <c>raw bits (3)</c><c>post-filter</c>
514 <c>tapset</c>       <c>[2, 1, 1]/4</c><c>post-filter</c>
515 <c>transient</c>    <c>[7, 1]/8</c><c></c>
516 <c>intra</c>        <c>[7, 1]/8</c><c></c>
517 <c>coarse energy</c><c><xref target="energy-decoding"/></c><c></c>
518 <c>tf_change</c>    <c><xref target="transient-decoding"/></c><c></c>
519 <c>tf_select</c>    <c>[1, 1]/2</c><c><xref target="transient-decoding"/></c>
520 <c>spread</c>       <c>[7, 2, 21, 2]/32</c><c></c>
521 <c>dyn. alloc.</c>  <c><xref target="allocation"/></c><c></c>
522 <c>alloc. trim</c>  <c>[2, 2, 5, 10, 22, 46, 22, 10, 5, 2, 2]/128</c><c></c>
523 <c>skip</c>         <c>[1, 1]/2</c><c><xref target="allocation"/></c>
524 <c>intensity</c>    <c>uniform</c><c><xref target="allocation"/></c>
525 <c>dual</c>         <c>[1, 1]/2</c><c></c>
526 <c>fine energy</c>  <c><xref target="energy-decoding"/></c><c></c>
527 <c>residual</c>     <c><xref target="PVQ-decoder"/></c><c></c>
528 <c>anti-collapse</c><c>[1, 1]/2</c><c><xref target="anti-collapse"/></c>
529 <c>finalize</c>     <c><xref target="energy-decoding"/></c><c></c>
530 <postamble>Order of the symbols in the CELT section of the bit-stream.</postamble>
531 </texttable>
532
533 <t>
534 The decoder extracts information from the range-coded bit-stream in the order
535 described in the figure above. In some circumstances, it is 
536 possible for a decoded value to be out of range due to a very small amount of redundancy
537 in the encoding of large integers by the range coder.
538 In that case, the decoder should assume there has been an error in the coding, 
539 decoding, or transmission and SHOULD take measures to conceal the error and/or report
540 to the application that a problem has occurred.
541 </t>
542
543 <section anchor="transient-decoding" title="Transient Decoding">
544 <t>
545 The <spanx style="emph">transient</spanx> flag encoded in the bit-stream has a
546 probability of 1/8. When it is set, then the MDCT coefficients represent multiple 
547 short MDCTs in the frame. When not set, the coefficients represent a single
548 long MDCT for the frame. In addition to the global transient flag is a per-band
549 binary flag to change the time-frequency (tf) resolution independently in each band. The 
550 change in tf resolution is defined in tf_select_table[][] in celt.c and depends
551 on the frame size, whether the transient flag is set, and the value of tf_select.
552 The tf_select flag uses a 1/2 probability, but is only decoded 
553 if it can have an impact on the result knowing the value of all per-band
554 tf_change flags. 
555 </t>
556 </section>
557
558 <section anchor="energy-decoding" title="Energy Envelope Decoding">
559
560 <t>
561 It is important to quantize the energy with sufficient resolution because
562 any energy quantization error cannot be compensated for at a later
563 stage. Regardless of the resolution used for encoding the shape of a band,
564 it is perceptually important to preserve the energy in each band. CELT uses a 
565 three-step coarse-fine-fine strategy for encoding the energy in the base-2 log
566 domain, as implemented in quant_bands.c</t>
567
568 <section anchor="coarse-energy-decoding" title="Coarse energy decoding">
569 <t>
570 Coarse quantization of the energy uses a fixed resolution of 6 dB
571 (integer part of base-2 log). To minimize the bitrate, prediction is applied
572 both in time (using the previous frame) and in frequency (using the previous
573 bands). The part of the prediction that is based on the
574 previous frame can be disabled, creating an "intra" frame where the energy
575 is coded without reference to prior frames. The decoder first reads the intra flag
576 to determine what prediction is used.
577 The 2-D z-transform of
578 the prediction filter is: A(z_l, z_b)=(1-a*z_l^-1)*(1-z_b^-1)/(1-b*z_b^-1)
579 where b is the band index and l is the frame index. The prediction coefficients
580 applied depend on the frame size in use when not using intra energy and a=0 b=4915/32768
581 when using intra energy.
582 The time-domain prediction is based on the final fine quantization of the previous
583 frame, while the frequency domain (within the current frame) prediction is based
584 on coarse quantization only (because the fine quantization has not been computed
585 yet). The prediction is clamped internally so that fixed point implementations with
586 limited dynamic range to not suffer desynchronization.  
587 We approximate the ideal
588 probability distribution of the prediction error using a Laplace distribution
589 with seperate parameters for each frame size in intra and inter-frame modes. The
590 coarse energy quantization is performed by unquant_coarse_energy() and 
591 unquant_coarse_energy_impl() (quant_bands.c). The encoding of the Laplace-distributed values is
592 implemented in ec_laplace_decode() (laplace.c).
593 </t>
594
595 </section>
596
597 <section anchor="fine-energy-decoding" title="Fine energy quantization">
598 <t>
599 The number of bits assigned to fine energy quantization in each band is determined
600 by the bit allocation computation described in <xref target="allocation"></xref>. 
601 Let B_i be the number of fine energy bits 
602 for band i; the refinement is an integer f in the range [0,2^B_i-1]. The mapping between f
603 and the correction applied to the coarse energy is equal to (f+1/2)/2^B_i - 1/2. Fine
604 energy quantization is implemented in quant_fine_energy() (quant_bands.c). 
605 </t>
606 <t>
607 When some bits are left "unused" after all other flags have been decoded, these bits
608 are assigned to a "final" step of fine allocation. In effect, these bits are used
609 to add one extra fine energy bit per band per channel. The allocation process 
610 determines two <spanx style="emph">priorities</spanx> for the final fine bits. 
611 Any remaining bits are first assigned only to bands of priority 0, starting 
612 from band 0 and going up. If all bands of priority 0 have received one bit per
613 channel, then bands of priority 1 are assigned an extra bit per channel, 
614 starting from band 0. If any bit is left after this, they are left unused.
615 This is implemented in unquant_energy_finalise() (quant_bands.c).
616 </t>
617
618 </section> <!-- fine energy -->
619
620 </section> <!-- Energy decode -->
621
622
623
624 <section anchor="allocation" title="Bit allocation">
625 <t>Bit allocation is performed based only on information available to both
626 the encoder and decoder. The same calculations are performed in a bit-exact
627 manner in both the encoder and decoder to ensure that the result is always
628 exactly the same. Any mismatch causes corruption of the decoded output.
629 The allocation is computed by compute_allocation() (rate.c),
630 which is used in both the encoder and the decoder.</t>
631
632 <t>For a given band, the bit allocation is nearly constant across
633 frames that use the same number of bits for Q1, yielding a 
634 pre-defined signal-to-mask ratio (SMR) for each band. Because the
635 bands each have a width of one Bark, this is equivalent to modeling the
636 masking occurring within each critical band, while ignoring inter-band
637 masking and tone-vs-noise characteristics. While this is not an
638 optimal bit allocation, it provides good results without requiring the
639 transmission of any allocation information. Additionally, the encoder
640 is able to signal alterations to the implicit allocation via
641 two means: There is an entropy coded trim parameter can be used to tilt the
642 allocation to favor low or high frequencies, and there is a boost parameter
643 which can be used to shift large amounts of additional precision into
644 individual bands.
645 </t>
646
647
648 <t>
649 For every encoded or decoded frame, a target allocation must be computed
650 using the projected allocation. In the reference implementation this is
651 performed by compute_allocation() (rate.c).
652 The target computation begins by calculating the available space as the
653 number of eighth-bits which can be fit in the frame after Q1 is stored according
654 to the range coder (ec_tell_frac()) and reserving one eighth-bit.
655 Then the two projected prototype allocations whose sums multiplied by 8 are nearest
656 to that value are determined. These two projected prototype allocations are then interpolated
657 by finding the highest integer interpolation coefficient in the range 0-63
658 such that the sum of the higher prototype times the coefficient divided by
659 64 plus the sum of the lower prototype multiplied is less than or equal to the
660 available eighth-bits. During the interpolation a maximum allocation
661 in each band is imposed along with a threshold hard minimum allocation for
662 each band.
663 Starting from the last coded band a binary decision is coded for each
664 band over the minimum threshold to determine if that band should instead
665 recieve only the minimum allocation. This process stops at the first
666 non-minimum band, the first band to recieve an explicitly coded boost,
667 or the first band in the frame, whichever comes first.
668 The reference implementation performs this step in interp_bits2pulses()
669 using a binary search for the interpolation. (rate.c).
670 </t>
671
672 <t>
673 Because the computed target will sometimes be somewhat smaller than the
674 available space, the excess space is divided by the number of bands, and this amount
675 is added equally to each band which was not forced to the minimum value.
676 </t>
677
678 <t>
679 The allocation target is separated into a portion used for fine energy
680 and a portion used for the Spherical Vector Quantizer (PVQ). The fine energy
681 quantizer operates in whole-bit steps and is allocated based on an offset
682 fraction of the total usable space. Excess bits above the maximums are
683 left unallocated and placed into the rolling balance maintained during
684 the quantization process.
685 </t>
686
687 </section>
688
689 <section anchor="PVQ-decoder" title="Shape Decoder">
690 <t>
691 In each band, the normalized <spanx style="emph">shape</spanx> is encoded
692 using a vector quantization scheme called a "Pyramid vector quantizer". 
693 </t>
694
695 <t>In
696 the simplest case, the number of bits allocated in 
697 <xref target="allocation"></xref> is converted to a number of pulses as described
698 by <xref target="bits-pulses"></xref>. Knowing the number of pulses and the
699 number of samples in the band, the decoder calculates the size of the codebook
700 as detailed in <xref target="cwrs-decoder"></xref>. The size is used to decode 
701 an unsigned integer (uniform probability model), which is the codeword index.
702 This index is converted into the corresponding vector as explained in
703 <xref target="cwrs-decoder"></xref>. This vector is then scaled to unit norm.
704 </t>
705
706 <section anchor="bits-pulses" title="Bits to Pulses">
707 <t>
708 Although the allocation is performed in 1/8th bit units, the quantization requires
709 an integer number of pulses K. To do this, the encoder searches for the value
710 of K that produces the number of bits that is the nearest to the allocated value
711 (rounding down if exactly half-way between two values), subject to not exceeding
712 the total number of bits available. For efficiency reasons the search is performed against a
713 precomputated allocation table which only permits some K values for each N. The number of
714 codebooks entries can be computed as explained in <xref target="cwrs-encoding"></xref>. The difference
715 between the number of bits allocated and the number of bits used is accumulated to a
716 <spanx style="emph">balance</spanx> (initialised to zero) that helps adjusting the
717 allocation for the next bands. One third of the balance is applied to the
718 bit allocation of the each band to help achieving the target allocation. The only
719 exceptions are the band before the last and the last band, for which half the balance
720 and the whole balance are applied, respectively.
721 </t>
722 </section>
723
724 <section anchor="cwrs-decoder" title="Index Decoding">
725
726 <t>
727 The codeword is decoded as a uniformly-distributed integer value
728 by decode_pulses() (cwrs.c).
729 The codeword is converted from a unique index in the same way as specified in 
730 <xref target="PVQ"></xref>. The indexing is based on the calculation of V(N,K) 
731 (denoted N(L,K) in <xref target="PVQ"></xref>), which is the number of possible
732 combinations of K pulses 
733 in N samples. The number of combinations can be computed recursively as 
734 V(N,K) = V(N-1,K) + V(N,K-1) + V(N-1,K-1), with V(N,0) = 1 and V(0,K) = 0, K != 0. 
735 There are many different ways to compute V(N,K), including pre-computed tables and direct
736 use of the recursive formulation. The reference implementation applies the recursive
737 formulation one line (or column) at a time to save on memory use,
738 along with an alternate,
739 univariate recurrence to initialise an arbitrary line, and direct
740 polynomial solutions for small N. All of these methods are
741 equivalent, and have different trade-offs in speed, memory usage, and
742 code size. Implementations MAY use any methods they like, as long as
743 they are equivalent to the mathematical definition.
744 </t>
745
746 <t>
747 The decoding of the codeword from the index is performed as specified in 
748 <xref target="PVQ"></xref>, as implemented in function
749 decode_pulses() (cwrs.c).
750 </t>
751 </section>
752
753 <section anchor="spreading" title="Spreading">
754 <t>
755 </t>
756 </section>
757
758 <section anchor="split" title="Split decoding">
759 <t>
760 To avoid the need for multi-precision calculations when decoding PVQ codevectors,
761 the maximum size allowed for codebooks is 32 bits. When larger codebooks are
762 needed, the vector is instead split in two sub-vectors of size N/2. 
763 A quantized gain parameter with precision
764 derived from the current allocation is entropy coded to represent the relative
765 gains of each side of the split and the entire decoding process is recursively
766 applied. Multiple levels of splitting may be applied up to a frame size 
767 dependent limit. The same recursive mechanism is applied for the joint coding
768 of stereo audio.
769 </t>
770
771 </section>
772
773 <section anchor="tf-change" title="Time-Frequency change">
774 <t>
775 </t>
776 </section>
777
778
779 </section>
780
781 <section anchor="anti-collapse" title="Anti-collapse processing">
782 <t>
783 When the frame has the transient bit set...
784 </t>
785 </section>
786
787 <section anchor="denormalization" title="Denormalization">
788 <t>
789 Just like each band was normalized in the encoder, the last step of the decoder before
790 the inverse MDCT is to denormalize the bands. Each decoded normalized band is
791 multiplied by the square root of the decoded energy. This is done by denormalise_bands()
792 (bands.c).
793 </t>
794 </section>
795
796 <section anchor="inverse-mdct" title="Inverse MDCT">
797 <t>The inverse MDCT implementation has no special characteristics. The
798 input is N frequency-domain samples and the output is 2*N time-domain 
799 samples, while scaling by 1/2. The output is windowed using the same window 
800 as the encoder. The IMDCT and windowing are performed by mdct_backward
801 (mdct.c). If a time-domain pre-emphasis 
802 window was applied in the encoder, the (inverse) time-domain de-emphasis window
803 is applied on the IMDCT result. 
804 </t>
805
806 <section anchor="post-filter" title="Post-filter">
807 <t>
808 The output of the inverse MDCT (after weighted overlap-add) is sent to the
809 post-filter. Although the post-filter is applied at the end, the post-filter
810 parameters are encoded at the beginning, just after the silence flag.
811 The post-filter can be switched on or off using one bit (logp=1).
812 If the post-filter is enabled, then the octave is decoded as an integer value
813 between 0 and 6 of uniform probability. Once the octave is known, the fine pitch
814 within the octave is decoded using 4+octave raw bits. The final pitch period
815 is equal to (16&lt;&lt;octave)+fine_pitch-1 so it is bounded between 15 and 1022,
816 inclusively. Next, the gain is decoded as three raw bits and is equal to 
817 G=3*(int_gain+1)/32. The set of post-filter taps is decoded last using 
818 a pdf equal to [2, 1, 1]/4. Tapset zero corresponds to the filter coefficients
819 g0 = 0.3066406250, g1 = 0.2170410156, g2 = 0.1296386719. Tapset one
820 corresponds to the filter coefficients g0 = 0.4638671875, g1 = 0.2680664062,
821 g2 = 0, and tapset two uses filter coefficients g0 = 0.7998046875,
822 g1 = 0.1000976562, g2 = 0.
823 </t>
824
825 <t>
826 The post-filter response is thus computed as:
827               <figure align="center">
828                 <artwork align="center">
829                   <![CDATA[
830    y(n) = x(n) + G*(g0*y(n-T) + g1*(y(n-T+1)+y(n-T+1)) 
831                               + g2*(y(n-T+2)+y(n-T+2)))
832 ]]>
833                 </artwork>
834               </figure>
835
836 During a transition between different gains, a smooth transition is calculated
837 using the square of the MDCT window. It is important that values of y(n) be 
838 interpolated one at a time such that the past value of y(n) used is interpolated.
839 </t>
840 </section>
841
842 <section anchor="deemphasis" title="De-emphasis">
843 <t>
844 After the post-filter, 
845 the signal is de-emphasized using the inverse of the pre-emphasis filter 
846 used in the encoder: 1/A(z)=1/(1-alpha_p*z^-1), where alpha_p=0.8500061035.
847 </t>
848 </section>
849
850 </section>
851
852 <section anchor="Packet Loss Concealment" title="Packet Loss Concealment (PLC)">
853 <t>
854 Packet loss concealment (PLC) is an optional decoder-side feature which 
855 SHOULD be included when transmitting over an unreliable channel. Because 
856 PLC is not part of the bit-stream, there are several possible ways to 
857 implement PLC with different complexity/quality trade-offs. The PLC in
858 the reference implementation finds a periodicity in the decoded
859 signal and repeats the windowed waveform using the pitch offset. The windowed
860 waveform is overlapped in such a way as to preserve the time-domain aliasing
861 cancellation with the previous frame and the next frame. This is implemented 
862 in celt_decode_lost() (mdct.c).
863 </t>
864 </section>
865
866 </section>
867
868 </section>
869
870
871 <!--  ******************************************************************* -->
872 <!--  **************************   OPUS ENCODER   *********************** -->
873 <!--  ******************************************************************* -->
874
875 <section title="Codec Encoder">
876 <t>
877 Opus encoder block diagram.
878 <figure>
879 <artwork>
880 <![CDATA[
881          +----------+    +-------+
882          |  sample  |    | SILK  |
883       +->|   rate   |--->|encoder|--+
884       |  |conversion|    |       |  |
885 audio |  +----------+    +-------+  |    +-------+
886 ------+                             +--->| Range |
887       |  +-------+                       |encoder|---->
888       |  | CELT  |                  +--->|       | bit-stream
889       +->|encoder|------------------+    +-------+
890          |       |
891          +-------+
892 ]]>
893 </artwork>
894 </figure>
895 </t>
896
897 <section anchor="range-encoder" title="Range Coder">
898 <t>
899 Opus uses an entropy coder based upon <xref target="range-coding"></xref>, 
900 which is itself a rediscovery of the FIFO arithmetic code introduced by <xref target="coding-thesis"></xref>.
901 It is very similar to arithmetic encoding, except that encoding is done with
902 digits in any base instead of with bits, 
903 so it is faster when using larger bases (i.e.: an octet). All of the
904 calculations in the range coder must use bit-exact integer arithmetic.
905 </t>
906
907 <t>
908 The range coder also acts as the bit-packer for Opus. It is
909 used in three different ways, to encode:
910 <list style="symbols">
911 <t>entropy-coded symbols with a fixed probability model using ec_encode(), (rangeenc.c)</t>
912 <t>integers from 0 to 2^M-1 using ec_enc_uint() or ec_enc_bits(), (entenc.c)</t>
913 <t>integers from 0 to N-1 (where N is not a power of two) using ec_enc_uint(). (entenc.c)</t>
914 </list>
915 </t>
916
917 <t>
918 The range encoder maintains an internal state vector composed of the
919 four-tuple (low,rng,rem,ext), representing the low end of the current
920 range, the size of the current range, a single buffered output octet,
921 and a count of additional carry-propagating output octets. Both rng
922 and low are 32-bit unsigned integer values, rem is an octet value or
923 the special value -1, and ext is an integer with at least 16 bits.
924 This state vector is initialized at the start of each each frame to
925 the value (0,2^31,-1,0).
926 </t>
927
928 <t>
929 Each symbol is drawn from a finite alphabet and coded in a separate
930 context which describes the size of the alphabet and the relative
931 frequency of each symbol in that alphabet. Opus only uses static
932 contexts; they are not adapted to the statistics of the data that is
933 coded.
934 </t>
935
936 <section anchor="encoding-symbols" title="Encoding Symbols">
937 <t>
938    The main encoding function is ec_encode() (rangeenc.c),
939    which takes as an argument a three-tuple (fl,fh,ft)
940    describing the range of the symbol to be encoded in the current
941    context, with 0 &lt;= fl &lt; fh &lt;= ft &lt;= 65535. The values of this tuple
942    are derived from the probability model for the symbol. Let f(i) be
943    the frequency of the ith symbol in the current context. Then the
944    three-tuple corresponding to the kth symbol is given by
945    <![CDATA[
946 fl=sum(f(i),i<k), fh=fl+f(i), and ft=sum(f(i)).
947 ]]>
948 </t>
949 <t>
950    ec_encode() updates the state of the encoder as follows. If fl is
951    greater than zero, then low = low + rng - (rng/ft)*(ft-fl) and 
952    rng = (rng/ft)*(fh-fl). Otherwise, low is unchanged and
953    rng = rng - (rng/ft)*(fh-fl). The divisions here are exact integer
954    division. After this update, the range is normalized.
955 </t>
956 <t>
957    To normalize the range, the following process is repeated until
958    rng > 2^23. First, the top 9 bits of low, (low>>23), are placed into
959    a carry buffer. Then, low is set to <![CDATA[(low << 8 & 0x7FFFFFFF) and rng
960    is set to (rng<<8)]]>. This process is carried out by
961    ec_enc_normalize() (rangeenc.c).
962 </t>
963 <t>
964    The 9 bits produced in each iteration of the normalization loop
965    consist of 8 data bits and a carry flag. The final value of the
966    output bits is not determined until carry propagation is accounted
967    for. Therefore the reference implementation buffers a single
968    (non-propagating) output octet and keeps a count of additional
969    propagating (0xFF) output octets. An implementation MAY choose to use
970    any mathematically equivalent scheme to perform carry propagation.
971 </t>
972 <t>
973    The function ec_enc_carry_out() (rangeenc.c) performs
974    this buffering. It takes a 9-bit input value, c, from the normalization
975    8-bit output and a carry bit. If c is 0xFF, then ext is incremented
976    and no octets are output. Otherwise, if rem is not the special value
977    -1, then the octet (rem+(c>>8)) is output. Then ext octets are output
978    with the value 0 if the carry bit is set, or 0xFF if it is not, and
979    rem is set to the lower 8 bits of c. After this, ext is set to zero.
980 </t>
981 <t>
982    In the reference implementation, a special version of ec_encode()
983    called ec_encode_bin() (rangeenc.c) is defined to
984    take a two-tuple (fl,ftb), where <![CDATA[0 <= fl < 2^ftb and ftb < 16. It is
985    mathematically equivalent to calling ec_encode() with the three-tuple
986    (fl,fl+1,1<<ftb)]]>, but avoids using division.
987
988 </t>
989 </section>
990
991 <section anchor="encoding-ints" title="Encoding Uniformly Distributed Integers">
992 <t>
993    Functions ec_enc_uint() or ec_enc_bits() are based on ec_encode() and 
994    encode one of N equiprobable symbols, each with a frequency of 1,
995    where N may be as large as 2^32-1. Because ec_encode() is limited to
996    a total frequency of 2^16-1, this is done by encoding a series of
997    symbols in smaller contexts.
998 </t>
999 <t>
1000    ec_enc_bits() (entenc.c) is defined, like
1001    ec_encode_bin(), to take a two-tuple (fl,ftb), with <![CDATA[0 <= fl < 2^ftb
1002    and ftb < 32. While ftb is greater than 8, it encodes bits (ftb-8) to
1003    (ftb-1) of fl, e.g., (fl>>ftb-8&0xFF) using ec_encode_bin() and
1004    subtracts 8 from ftb. Then, it encodes the remaining bits of fl, e.g.,
1005    (fl&(1<<ftb)-1)]]>, again using ec_encode_bin().
1006 </t>
1007 <t>
1008    ec_enc_uint() (entenc.c) takes a two-tuple (fl,ft),
1009    where ft is not necessarily a power of two. Let ftb be the location
1010    of the highest 1 bit in the two's-complement representation of
1011    (ft-1), or -1 if no bits are set. If ftb>8, then the top 8 bits of fl
1012    are encoded using ec_encode() with the three-tuple
1013    (fl>>ftb-8,(fl>>ftb-8)+1,(ft-1>>ftb-8)+1), and the remaining bits
1014    are encoded with ec_enc_bits using the two-tuple
1015    <![CDATA[(fl&(1<<ftb-8)-1,ftb-8). Otherwise, fl is encoded with ec_encode()
1016    directly using the three-tuple (fl,fl+1,ft)]]>.
1017 </t>
1018 </section>
1019
1020 <section anchor="encoder-finalizing" title="Finalizing the Stream">
1021 <t>
1022    After all symbols are encoded, the stream must be finalized by
1023    outputting a value inside the current range. Let end be the integer
1024    in the interval [low,low+rng) with the largest number of trailing
1025    zero bits. Then while end is not zero, the top 9 bits of end, e.g.,
1026    <![CDATA[(end>>23), are sent to the carry buffer, and end is replaced by
1027    (end<<8&0x7FFFFFFF). Finally, if the value in carry buffer, rem, is]]>
1028    neither zero nor the special value -1, or the carry count, ext, is
1029    greater than zero, then 9 zero bits are sent to the carry buffer.
1030    After the carry buffer is finished outputting octets, the rest of the
1031    output buffer is padded with zero octets. Finally, rem is set to the
1032    special value -1. This process is implemented by ec_enc_done()
1033    (rangeenc.c).
1034 </t>
1035 </section>
1036
1037 <section anchor="encoder-tell" title="Current Bit Usage">
1038 <t>
1039    The bit allocation routines in Opus need to be able to determine a
1040    conservative upper bound on the number of bits that have been used
1041    to encode the current frame thus far. This drives allocation
1042    decisions and ensures that the range code will not overflow the
1043    output buffer. This is computed in the reference implementation to
1044    fractional bit precision by the function ec_enc_tell() 
1045    (rangeenc.c).
1046    Like all operations in the range encoder, it must
1047    be implemented in a bit-exact manner.
1048 </t>
1049 </section>
1050
1051 </section>
1052
1053         <section title='SILK Encoder'>
1054           <t>
1055             In the following, we focus on the core encoder and describe its components. For simplicity, we will refer to the core encoder simply as the encoder in the remainder of this document. An overview of the encoder is given in <xref target="encoder_figure" />.
1056           </t>
1057
1058           <figure align="center" anchor="encoder_figure">
1059             <artwork align="center">
1060               <![CDATA[
1061                                                               +---+
1062                                +----------------------------->|   |
1063         +---------+            |     +---------+              |   |
1064         |Voice    |            |     |LTP      |              |   |
1065  +----->|Activity |-----+      +---->|Scaling  |---------+--->|   |
1066  |      |Detector |  3  |      |     |Control  |<+  12   |    |   |
1067  |      +---------+     |      |     +---------+ |       |    |   |
1068  |                      |      |     +---------+ |       |    |   |
1069  |                      |      |     |Gains    | |  11   |    |   |
1070  |                      |      |  +->|Processor|-|---+---|--->| R |
1071  |                      |      |  |  |         | |   |   |    | a |
1072  |                     \/      |  |  +---------+ |   |   |    | n |
1073  |                 +---------+ |  |  +---------+ |   |   |    | g |
1074  |                 |Pitch    | |  |  |LSF      | |   |   |    | e |
1075  |              +->|Analysis |-+  |  |Quantizer|-|---|---|--->|   |
1076  |              |  |         |4|  |  |         | | 8 |   |    | E |->
1077  |              |  +---------+ |  |  +---------+ |   |   |    | n |14
1078  |              |              |  |   9/\  10|   |   |   |    | c |
1079  |              |              |  |    |    \/   |   |   |    | o |
1080  |              |  +---------+ |  |  +----------+|   |   |    | d |
1081  |              |  |Noise    | +--|->|Prediction|+---|---|--->| e |
1082  |              +->|Shaping  |-|--+  |Analysis  || 7 |   |    | r |
1083  |              |  |Analysis |5|  |  |          ||   |   |    |   |
1084  |              |  +---------+ |  |  +----------+|   |   |    |   |
1085  |              |              |  |       /\     |   |   |    |   |
1086  |              |    +---------|--|-------+      |   |   |    |   |
1087  |              |    |        \/  \/            \/  \/  \/    |   |
1088  |  +---------+ |    |      +---------+       +------------+  |   |
1089  |  |High-Pass| |    |      |         |       |Noise       |  |   |
1090 -+->|Filter   |-+----+----->|Prefilter|------>|Shaping     |->|   |
1091 1   |         |      2      |         |   6   |Quantization|13|   |
1092     +---------+             +---------+       +------------+  +---+
1093
1094 1:  Input speech signal
1095 2:  High passed input signal
1096 3:  Voice activity estimate
1097 4:  Pitch lags (per 5 ms) and voicing decision (per 20 ms)
1098 5:  Noise shaping quantization coefficients
1099   - Short term synthesis and analysis 
1100     noise shaping coefficients (per 5 ms)
1101   - Long term synthesis and analysis noise 
1102     shaping coefficients (per 5 ms and for voiced speech only)
1103   - Noise shaping tilt (per 5 ms)
1104   - Quantizer gain/step size (per 5 ms)
1105 6:  Input signal filtered with analysis noise shaping filters
1106 7:  Short and long term prediction coefficients
1107     LTP (per 5 ms) and LPC (per 20 ms)
1108 8:  LSF quantization indices
1109 9:  LSF coefficients
1110 10: Quantized LSF coefficients 
1111 11: Processed gains, and synthesis noise shape coefficients
1112 12: LTP state scaling coefficient. Controlling error propagation
1113    / prediction gain trade-off
1114 13: Quantized signal
1115 14: Range encoded bitstream
1116
1117 ]]>
1118             </artwork>
1119             <postamble>Encoder block diagram.</postamble>
1120           </figure>
1121
1122           <section title='Voice Activity Detection'>
1123             <t>
1124               The input signal is processed by a VAD (Voice Activity Detector) to produce a measure of voice activity, and also spectral tilt and signal-to-noise estimates, for each frame. The VAD uses a sequence of half-band filterbanks to split the signal in four subbands: 0 - Fs/16, Fs/16 - Fs/8, Fs/8 - Fs/4, and Fs/4 - Fs/2, where Fs is the sampling frequency, that is, 8, 12, 16 or 24 kHz. The lowest subband, from 0 - Fs/16 is high-pass filtered with a first-order MA (Moving Average) filter (with transfer function H(z) = 1-z^(-1)) to reduce the energy at the lowest frequencies. For each frame, the signal energy per subband is computed. In each subband, a noise level estimator tracks the background noise level and an SNR (Signal-to-Noise Ratio) value is computed as the logarithm of the ratio of energy to noise level. Using these intermediate variables, the following parameters are calculated for use in other SILK modules:
1125               <list style="symbols">
1126                 <t>
1127                   Average SNR. The average of the subband SNR values.
1128                 </t>
1129
1130                 <t>
1131                   Smoothed subband SNRs. Temporally smoothed subband SNR values.
1132                 </t>
1133
1134                 <t>
1135                   Speech activity level. Based on the average SNR and a weighted average of the subband energies.
1136                 </t>
1137
1138                 <t>
1139                   Spectral tilt. A weighted average of the subband SNRs, with positive weights for the low subbands and negative weights for the high subbands.
1140                 </t>
1141               </list>
1142             </t>
1143           </section>
1144
1145           <section title='High-Pass Filter'>
1146             <t>
1147               The input signal is filtered by a high-pass filter to remove the lowest part of the spectrum that contains little speech energy and may contain background noise. This is a second order ARMA (Auto Regressive Moving Average) filter with a cut-off frequency around 70 Hz.
1148             </t>
1149             <t>
1150               In the future, a music detector may also be used to lower the cut-off frequency when the input signal is detected to be music rather than speech.
1151             </t>
1152           </section>
1153
1154           <section title='Pitch Analysis' anchor='pitch_estimator_overview_section'>
1155             <t>
1156               The high-passed input signal is processed by the open loop pitch estimator shown in <xref target='pitch_estimator_figure' />.
1157               <figure align="center" anchor="pitch_estimator_figure">
1158                 <artwork align="center">
1159                   <![CDATA[
1160                                  +--------+  +----------+     
1161                                  |2 x Down|  |Time-     |      
1162                               +->|sampling|->|Correlator|     |
1163                               |  |        |  |          |     |4
1164                               |  +--------+  +----------+    \/
1165                               |                    | 2    +-------+
1166                               |                    |  +-->|Speech |5
1167     +---------+    +--------+ |                   \/  |   |Type   |->
1168     |LPC      |    |Down    | |              +----------+ |       |
1169  +->|Analysis | +->|sample  |-+------------->|Time-     | +-------+
1170  |  |         | |  |to 8 kHz|                |Correlator|----------->
1171  |  +---------+ |  +--------+                |__________|          6
1172  |       |      |                                  |3
1173  |      \/      |                                 \/ 
1174  |  +---------+ |                            +----------+
1175  |  |Whitening| |                            |Time-     |    
1176 -+->|Filter   |-+--------------------------->|Correlator|----------->
1177 1   |         |                              |          |          7
1178     +---------+                              +----------+ 
1179                                             
1180 1: Input signal
1181 2: Lag candidates from stage 1
1182 3: Lag candidates from stage 2
1183 4: Correlation threshold
1184 5: Voiced/unvoiced flag
1185 6: Pitch correlation
1186 7: Pitch lags 
1187 ]]>
1188                 </artwork>
1189                 <postamble>Block diagram of the pitch estimator.</postamble>
1190               </figure>
1191               The pitch analysis finds a binary voiced/unvoiced classification, and, for frames classified as voiced, four pitch lags per frame - one for each 5 ms subframe - and a pitch correlation indicating the periodicity of the signal. The input is first whitened using a Linear Prediction (LP) whitening filter, where the coefficients are computed through standard Linear Prediction Coding (LPC) analysis. The order of the whitening filter is 16 for best results, but is reduced to 12 for medium complexity and 8 for low complexity modes. The whitened signal is analyzed to find pitch lags for which the time correlation is high. The analysis consists of three stages for reducing the complexity:
1192               <list style="symbols">
1193                 <t>In the first stage, the whitened signal is downsampled to 4 kHz (from 8 kHz) and the current frame is correlated to a signal delayed by a range of lags, starting from a shortest lag corresponding to 500 Hz, to a longest lag corresponding to 56 Hz.</t>
1194
1195                 <t>
1196                   The second stage operates on a 8 kHz signal ( downsampled from 12, 16 or 24 kHz ) and measures time correlations only near the lags corresponding to those that had sufficiently high correlations in the first stage. The resulting correlations are adjusted for a small bias towards short lags to avoid ending up with a multiple of the true pitch lag. The highest adjusted correlation is compared to a threshold depending on:
1197                   <list style="symbols">
1198                     <t>
1199                       Whether the previous frame was classified as voiced
1200                     </t>
1201                     <t>
1202                       The speech activity level
1203                     </t>
1204                     <t>
1205                       The spectral tilt.
1206                     </t>
1207                   </list>
1208                   If the threshold is exceeded, the current frame is classified as voiced and the lag with the highest adjusted correlation is stored for a final pitch analysis of the highest precision in the third stage.
1209                 </t>
1210                 <t>
1211                   The last stage operates directly on the whitened input signal to compute time correlations for each of the four subframes independently in a narrow range around the lag with highest correlation from the second stage.
1212                 </t>
1213               </list>
1214             </t>
1215           </section>
1216
1217           <section title='Noise Shaping Analysis' anchor='noise_shaping_analysis_overview_section'>
1218             <t>
1219               The noise shaping analysis finds gains and filter coefficients used in the prefilter and noise shaping quantizer. These parameters are chosen such that they will fulfil several requirements:
1220               <list style="symbols">
1221                 <t>Balancing quantization noise and bitrate. The quantization gains determine the step size between reconstruction levels of the excitation signal. Therefore, increasing the quantization gain amplifies quantization noise, but also reduces the bitrate by lowering the entropy of the quantization indices.</t>
1222                 <t>Spectral shaping of the quantization noise; the noise shaping quantizer is capable of reducing quantization noise in some parts of the spectrum at the cost of increased noise in other parts without substantially changing the bitrate. By shaping the noise such that it follows the signal spectrum, it becomes less audible. In practice, best results are obtained by making the shape of the noise spectrum slightly flatter than the signal spectrum.</t>
1223                 <t>Deemphasizing spectral valleys; by using different coefficients in the analysis and synthesis part of the prefilter and noise shaping quantizer, the levels of the spectral valleys can be decreased relative to the levels of the spectral peaks such as speech formants and harmonics. This reduces the entropy of the signal, which is the difference between the coded signal and the quantization noise, thus lowering the bitrate.</t>
1224                 <t>Matching the levels of the decoded speech formants to the levels of the original speech formants; an adjustment gain and a first order tilt coefficient are computed to compensate for the effect of the noise shaping quantization on the level and spectral tilt.</t>
1225               </list>
1226             </t>
1227             <t>
1228               <figure align="center" anchor="noise_shape_analysis_spectra_figure">
1229                 <artwork align="center">
1230                   <![CDATA[
1231   / \   ___
1232    |   // \\
1233    |  //   \\     ____
1234    |_//     \\___//  \\         ____
1235    | /  ___  \   /    \\       //  \\
1236  P |/  /   \  \_/      \\_____//    \\
1237  o |  /     \     ____  \     /      \\
1238  w | /       \___/    \  \___/  ____  \\___ 1
1239  e |/                  \       /    \  \    
1240  r |                    \_____/      \  \__ 2
1241    |                                  \     
1242    |                                   \___ 3
1243    |
1244    +---------------------------------------->
1245                     Frequency
1246
1247 1: Input signal spectrum
1248 2: Deemphasized and level matched spectrum
1249 3: Quantization noise spectrum
1250 ]]>
1251                 </artwork>
1252                 <postamble>Noise shaping and spectral de-emphasis illustration.</postamble>
1253               </figure>
1254               <xref target='noise_shape_analysis_spectra_figure' /> shows an example of an input signal spectrum (1). After de-emphasis and level matching, the spectrum has deeper valleys (2). The quantization noise spectrum (3) more or less follows the input signal spectrum, while having slightly less pronounced peaks. The entropy, which provides a lower bound on the bitrate for encoding the excitation signal, is proportional to the area between the deemphasized spectrum (2) and the quantization noise spectrum (3). Without de-emphasis, the entropy is proportional to the area between input spectrum (1) and quantization noise (3) - clearly higher.
1255             </t>
1256
1257             <t>
1258               The transformation from input signal to deemphasized signal can be described as a filtering operation with a filter
1259               <figure align="center">
1260                 <artwork align="center">
1261                   <![CDATA[
1262                                      Wana(z)
1263 H(z) = G * ( 1 - c_tilt * z^(-1) ) * -------
1264                                      Wsyn(z),
1265             ]]>
1266                 </artwork>
1267               </figure>
1268               having an adjustment gain G, a first order tilt adjustment filter with
1269               tilt coefficient c_tilt, and where
1270               <figure align="center">
1271                 <artwork align="center">
1272                   <![CDATA[
1273                16                                 d
1274                __                                __
1275 Wana(z) = (1 - \ (a_ana(k) * z^(-k))*(1 - z^(-L) \ b_ana(k)*z^(-k)),
1276                /_                                /_  
1277                k=1                               k=-d
1278             ]]>
1279                 </artwork>
1280               </figure>
1281               is the analysis part of the de-emphasis filter, consisting of the short-term shaping filter with coefficients a_ana(k), and the long-term shaping filter with coefficients b_ana(k) and pitch lag L. The parameter d determines the number of long-term shaping filter taps.
1282             </t>
1283
1284             <t>
1285               Similarly, but without the tilt adjustment, the synthesis part can be written as
1286               <figure align="center">
1287                 <artwork align="center">
1288                   <![CDATA[
1289                16                                 d
1290                __                                __
1291 Wsyn(z) = (1 - \ (a_syn(k) * z^(-k))*(1 - z^(-L) \ b_syn(k)*z^(-k)).
1292                /_                                /_  
1293                k=1                               k=-d
1294             ]]>
1295                 </artwork>
1296               </figure>
1297             </t>
1298             <t>
1299               All noise shaping parameters are computed and applied per subframe of 5 milliseconds. First, an LPC analysis is performed on a windowed signal block of 15 milliseconds. The signal block has a look-ahead of 5 milliseconds relative to the current subframe, and the window is an asymmetric sine window. The LPC analysis is done with the autocorrelation method, with an order of 16 for best quality or 12 in low complexity operation. The quantization gain is found as the square-root of the residual energy from the LPC analysis, multiplied by a value inversely proportional to the coding quality control parameter and the pitch correlation.
1300             </t>
1301             <t>
1302               Next we find the two sets of short-term noise shaping coefficients a_ana(k) and a_syn(k), by applying different amounts of bandwidth expansion to the coefficients found in the LPC analysis. This bandwidth expansion moves the roots of the LPC polynomial towards the origo, using the formulas
1303               <figure align="center">
1304                 <artwork align="center">
1305                   <![CDATA[
1306  a_ana(k) = a(k)*g_ana^k, and
1307  a_syn(k) = a(k)*g_syn^k,
1308             ]]>
1309                 </artwork>
1310               </figure>
1311               where a(k) is the k'th LPC coefficient and the bandwidth expansion factors g_ana and g_syn are calculated as
1312               <figure align="center">
1313                 <artwork align="center">
1314                   <![CDATA[
1315 g_ana = 0.94 - 0.02*C, and
1316 g_syn = 0.94 + 0.02*C,
1317             ]]>
1318                 </artwork>
1319               </figure>
1320               where C is the coding quality control parameter between 0 and 1. Applying more bandwidth expansion to the analysis part than to the synthesis part gives the desired de-emphasis of spectral valleys in between formants.
1321             </t>
1322
1323             <t>
1324               The long-term shaping is applied only during voiced frames. It uses three filter taps, described by
1325               <figure align="center">
1326                 <artwork align="center">
1327                   <![CDATA[
1328 b_ana = F_ana * [0.25, 0.5, 0.25], and
1329 b_syn = F_syn * [0.25, 0.5, 0.25].
1330             ]]>
1331                 </artwork>
1332               </figure>
1333               For unvoiced frames these coefficients are set to 0. The multiplication factors F_ana and F_syn are chosen between 0 and 1, depending on the coding quality control parameter, as well as the calculated pitch correlation and smoothed subband SNR of the lowest subband. By having F_ana less than F_syn, the pitch harmonics are emphasized relative to the valleys in between the harmonics.
1334             </t>
1335
1336             <t>
1337               The tilt coefficient c_tilt is for unvoiced frames chosen as
1338               <figure align="center">
1339                 <artwork align="center">
1340                   <![CDATA[
1341 c_tilt = 0.4, and as
1342 c_tilt = 0.04 + 0.06 * C
1343             ]]>
1344                 </artwork>
1345               </figure>
1346               for voiced frames, where C again is the coding quality control parameter and is between 0 and 1.
1347             </t>
1348             <t>
1349               The adjustment gain G serves to correct any level mismatch between original and decoded signal that might arise from the noise shaping and de-emphasis. This gain is computed as the ratio of the prediction gain of the short-term analysis and synthesis filter coefficients. The prediction gain of an LPC synthesis filter is the square-root of the output energy when the filter is excited by a unit-energy impulse on the input. An efficient way to compute the prediction gain is by first computing the reflection coefficients from the LPC coefficients through the step-down algorithm, and extracting the prediction gain from the reflection coefficients as
1350               <figure align="center">
1351                 <artwork align="center">
1352                   <![CDATA[
1353                K
1354               ___
1355  predGain = ( | | 1 - (r_k)^2 )^(-0.5),
1356               k=1
1357             ]]>
1358                 </artwork>
1359               </figure>
1360               where r_k is the k'th reflection coefficient.
1361             </t>
1362
1363             <t>
1364               Initial values for the quantization gains are computed as the square-root of the residual energy of the LPC analysis, adjusted by the coding quality control parameter. These quantization gains are later adjusted based on the results of the prediction analysis.
1365             </t>
1366           </section>
1367
1368           <section title='Prefilter'>
1369             <t>
1370               In the prefilter the input signal is filtered using the spectral valley de-emphasis filter coefficients from the noise shaping analysis, see <xref target='noise_shaping_analysis_overview_section' />. By applying only the noise shaping analysis filter to the input signal, it provides the input to the noise shaping quantizer.
1371             </t>
1372           </section>
1373           <section title='Prediction Analysis' anchor='pred_ana_overview_section'>
1374             <t>
1375               The prediction analysis is performed in one of two ways depending on how the pitch estimator classified the frame. The processing for voiced and unvoiced speech are described in <xref target='pred_ana_voiced_overview_section' /> and <xref target='pred_ana_unvoiced_overview_section' />, respectively. Inputs to this function include the pre-whitened signal from the pitch estimator, see <xref target='pitch_estimator_overview_section' />.
1376             </t>
1377
1378             <section title='Voiced Speech' anchor='pred_ana_voiced_overview_section'>
1379               <t>
1380                 For a frame of voiced speech the pitch pulses will remain dominant in the pre-whitened input signal. Further whitening is desirable as it leads to higher quality at the same available bit-rate. To achieve this, a Long-Term Prediction (LTP) analysis is carried out to estimate the coefficients of a fifth order LTP filter for each of four sub-frames. The LTP coefficients are used to find an LTP residual signal with the simulated output signal as input to obtain better modelling of the output signal. This LTP residual signal is the input to an LPC analysis where the LPCs are estimated using Burgs method, such that the residual energy is minimized. The estimated LPCs are converted to a Line Spectral Frequency (LSF) vector, and quantized as described in <xref target='lsf_quantizer_overview_section' />. After quantization, the quantized LSF vector is converted to LPC coefficients and hence by using these quantized coefficients the encoder remains fully synchronized with the decoder. The LTP coefficients are quantized using a method described in <xref target='ltp_quantizer_overview_section' />. The quantized LPC and LTP coefficients are now used to filter the high-pass filtered input signal and measure a residual energy for each of the four subframes.
1381               </t>
1382             </section>
1383             <section title='Unvoiced Speech' anchor='pred_ana_unvoiced_overview_section'>
1384               <t>
1385                 For a speech signal that has been classified as unvoiced there is no need for LTP filtering as it has already been determined that the pre-whitened input signal is not periodic enough within the allowed pitch period range for an LTP analysis to be worth-while the cost in terms of complexity and rate. Therefore, the pre-whitened input signal is discarded and instead the high-pass filtered input signal is used for LPC analysis using Burgs method. The resulting LPC coefficients are converted to an LSF vector, quantized as described in the following section and transformed back to obtain quantized LPC coefficients. The quantized LPC coefficients are used to filter the high-pass filtered input signal and measure a residual energy for each of the four subframes.
1386               </t>
1387             </section>
1388           </section>
1389
1390           <section title='LSF Quantization' anchor='lsf_quantizer_overview_section'>
1391             <t>The purpose of quantization in general is to significantly lower the bit rate at the cost of some introduced distortion. A higher rate should always result in lower distortion, and lowering the rate will generally lead to higher distortion. A commonly used but generally sub-optimal approach is to use a quantization method with a constant rate where only the error is minimized when quantizing.</t>
1392             <section title='Rate-Distortion Optimization'>
1393               <t>Instead, we minimize an objective function that consists of a weighted sum of rate and distortion, and use a codebook with an associated non-uniform rate table. Thus, we take into account that the probability mass function for selecting the codebook entries are by no means guaranteed to be uniform in our scenario. The advantage of this approach is that it ensures that rarely used codebook vector centroids, which are modelling statistical outliers in the training set can be quantized with a low error but with a relatively high cost in terms of a high rate. At the same time this approach also provides the advantage that frequently used centroids are modelled with low error and a relatively low rate. This approach will lead to equal or lower distortion than the fixed rate codebook at any given average rate, provided that the data is similar to the data used for training the codebook.</t>
1394             </section>
1395
1396             <section title='Error Mapping' anchor='lsf_error_mapping_overview_section'>
1397               <t>
1398                 Instead of minimizing the error in the LSF domain, we map the errors to better approximate spectral distortion by applying an individual weight to each element in the error vector. The weight vectors are calculated for each input vector using the Inverse Harmonic Mean Weighting (IHMW) function proposed by Laroia et al., see <xref target="laroia-icassp" />.
1399                 Consequently, we solve the following minimization problem, i.e.,
1400                 <figure align="center">
1401                   <artwork align="center">
1402                     <![CDATA[
1403 LSF_q = argmin { (LSF - c)' * W * (LSF - c) + mu * rate },
1404         c in C
1405             ]]>
1406                   </artwork>
1407                 </figure>
1408                 where LSF_q is the quantized vector, LSF is the input vector to be quantized, and c is the quantized LSF vector candidate taken from the set C of all possible outcomes of the codebook.
1409               </t>
1410             </section>
1411             <section title='Multi-Stage Vector Codebook'>
1412               <t>
1413                 We arrange the codebook in a multiple stage structure to achieve a quantizer that is both memory efficient and highly scalable in terms of computational complexity, see e.g. <xref target="sinervo-norsig" />. In the first stage the input is the LSF vector to be quantized, and in any other stage s > 1, the input is the quantization error from the previous stage, see <xref target='lsf_quantizer_structure_overview_figure' />.
1414                 <figure align="center" anchor="lsf_quantizer_structure_overview_figure">
1415                   <artwork align="center">
1416                     <![CDATA[
1417       Stage 1:           Stage 2:                Stage S:
1418     +----------+       +----------+            +----------+
1419     |  c_{1,1} |       |  c_{2,1} |            |  c_{S,1} | 
1420 LSF +----------+ res_1 +----------+  res_{S-1} +----------+
1421 --->|  c_{1,2} |------>|  c_{2,2} |--> ... --->|  c_{S,2} |--->
1422     +----------+       +----------+            +----------+ res_S =
1423         ...                ...                     ...      LSF-LSF_q
1424     +----------+       +----------+            +----------+ 
1425     |c_{1,M1-1}|       |c_{2,M2-1}|            |c_{S,MS-1}|
1426     +----------+       +----------+            +----------+     
1427     | c_{1,M1} |       | c_{2,M2} |            | c_{S,MS} |
1428     +----------+       +----------+            +----------+
1429 ]]>
1430                   </artwork>
1431                   <postamble>Multi-Stage LSF Vector Codebook Structure.</postamble>
1432                 </figure>
1433               </t>
1434
1435               <t>
1436                 By storing total of M codebook vectors, i.e.,
1437                 <figure align="center">
1438                   <artwork align="center">
1439                     <![CDATA[
1440      S
1441     __
1442 M = \  Ms,
1443     /_
1444     s=1
1445 ]]>
1446                   </artwork>
1447                 </figure>
1448                 where M_s is the number of vectors in stage s, we obtain a total of
1449                 <figure align="center">
1450                   <artwork align="center">
1451                     <![CDATA[
1452      S
1453     ___
1454 T = | | Ms
1455     s=1
1456 ]]>
1457                   </artwork>
1458                 </figure>
1459                 possible combinations for generating the quantized vector. It is for example possible to represent 2^36 uniquely combined vectors using only 216 vectors in memory, as done in SILK for voiced speech at all sample frequencies above 8 kHz.
1460               </t>
1461             </section>
1462             <section title='Survivor Based Codebook Search'>
1463               <t>
1464                 This number of possible combinations is far too high for a full search to be carried out for each frame so for all stages but the last, i.e., s smaller than S, only the best min( L, Ms ) centroids are carried over to stage s+1. In each stage the objective function, i.e., the weighted sum of accumulated bit-rate and distortion, is evaluated for each codebook vector entry and the results are sorted. Only the best paths and the corresponding quantization errors are considered in the next stage. In the last stage S the single best path through the multistage codebook is determined. By varying the maximum number of survivors from each stage to the next L, the complexity can be adjusted in real-time at the cost of a potential increase when evaluating the objective function for the resulting quantized vector. This approach scales all the way between the two extremes, L=1 being a greedy search, and the desirable but infeasible full search, L=T/MS. In fact, a performance almost as good as what can be achieved with the infeasible full search can be obtained at a substantially lower complexity by using this approach, see e.g. <xref target='leblanc-tsap' />.
1465               </t>
1466             </section>
1467             <section title='LSF Stabilization' anchor='lsf_stabilizer_overview_section'>
1468               <t>If the input is stable, finding the best candidate will usually result in the quantized vector also being stable, but due to the multi-stage approach it could in theory happen that the best quantization candidate is unstable and because of this there is a need to explicitly ensure that the quantized vectors are stable. Therefore we apply a LSF stabilization method which ensures that the LSF parameters are within valid range, increasingly sorted, and have minimum distances between each other and the border values that have been pre-determined as the 0.01 percentile distance values from a large training set.</t>
1469             </section>
1470             <section title='Off-Line Codebook Training'>
1471               <t>
1472                 The vectors and rate tables for the multi-stage codebook have been trained by minimizing the average of the objective function for LSF vectors from a large training set.
1473               </t>
1474             </section>
1475           </section>
1476
1477           <section title='LTP Quantization' anchor='ltp_quantizer_overview_section'>
1478             <t>
1479               For voiced frames, the prediction analysis described in <xref target='pred_ana_voiced_overview_section' /> resulted in four sets (one set per subframe) of five LTP coefficients, plus four weighting matrices. Also, the LTP coefficients for each subframe are quantized using entropy constrained vector quantization. A total of three vector codebooks are available for quantization, with different rate-distortion trade-offs. The three codebooks have 10, 20 and 40 vectors and average rates of about 3, 4, and 5 bits per vector, respectively. Consequently, the first codebook has larger average quantization distortion at a lower rate, whereas the last codebook has smaller average quantization distortion at a higher rate. Given the weighting matrix W_ltp and LTP vector b, the weighted rate-distortion measure for a codebook vector cb_i with rate r_i is give by
1480               <figure align="center">
1481                 <artwork align="center">
1482                   <![CDATA[
1483  RD = u * (b - cb_i)' * W_ltp * (b - cb_i) + r_i,
1484 ]]>
1485                 </artwork>
1486               </figure>
1487               where u is a fixed, heuristically-determined parameter balancing the distortion and rate. Which codebook gives the best performance for a given LTP vector depends on the weighting matrix for that LTP vector. For example, for a low valued W_ltp, it is advantageous to use the codebook with 10 vectors as it has a lower average rate. For a large W_ltp, on the other hand, it is often better to use the codebook with 40 vectors, as it is more likely to contain the best codebook vector.
1488               The weighting matrix W_ltp depends mostly on two aspects of the input signal. The first is the periodicity of the signal; the more periodic the larger W_ltp. The second is the change in signal energy in the current subframe, relative to the signal one pitch lag earlier. A decaying energy leads to a larger W_ltp than an increasing energy. Both aspects do not fluctuate very fast which causes the W_ltp matrices for different subframes of one frame often to be similar. As a result, one of the three codebooks typically gives good performance for all subframes. Therefore the codebook search for the subframe LTP vectors is constrained to only allow codebook vectors to be chosen from the same codebook, resulting in a rate reduction.
1489             </t>
1490
1491             <t>
1492               To find the best codebook, each of the three vector codebooks is used to quantize all subframe LTP vectors and produce a combined weighted rate-distortion measure for each vector codebook and the vector codebook with the lowest combined rate-distortion over all subframes is chosen. The quantized LTP vectors are used in the noise shaping quantizer, and the index of the codebook plus the four indices for the four subframe codebook vectors are passed on to the range encoder.
1493             </t>
1494           </section>
1495
1496
1497           <section title='Noise Shaping Quantizer'>
1498             <t>
1499               The noise shaping quantizer independently shapes the signal and coding noise spectra to obtain a perceptually higher quality at the same bitrate.
1500             </t>
1501             <t>
1502               The prefilter output signal is multiplied with a compensation gain G computed in the noise shaping analysis. Then the output of a synthesis shaping filter is added, and the output of a prediction filter is subtracted to create a residual signal. The residual signal is multiplied by the inverse quantized quantization gain from the noise shaping analysis, and input to a scalar quantizer. The quantization indices of the scalar quantizer represent a signal of pulses that is input to the pyramid range encoder. The scalar quantizer also outputs a quantization signal, which is multiplied by the quantized quantization gain from the noise shaping analysis to create an excitation signal. The output of the prediction filter is added to the excitation signal to form the quantized output signal y(n). The quantized output signal y(n) is input to the synthesis shaping and prediction filters.
1503             </t>
1504
1505           </section>
1506
1507           <section title='Range Encoder'>
1508             <t>
1509               Range encoding is a well known method for entropy coding in which a bitstream sequence is continually updated with every new symbol, based on the probability for that symbol. It is similar to arithmetic coding but rather than being restricted to generating binary output symbols, it can generate symbols in any chosen number base. In SILK all side information is range encoded. Each quantized parameter has its own cumulative density function based on histograms for the quantization indices obtained by running a training database.
1510             </t>
1511
1512             <section title='Bitstream Encoding Details'>
1513               <t>
1514                 TBD.
1515               </t>
1516             </section>
1517           </section>
1518         </section>
1519
1520
1521 <section title="CELT Encoder">
1522 <t>
1523 Copy from CELT draft.
1524 </t>
1525
1526 <section anchor="prefilter" title="Pre-filter">
1527 <t>
1528 Inverse of the post-filter
1529 </t>
1530 </section>
1531
1532
1533 <section anchor="forward-mdct" title="Forward MDCT">
1534
1535 <t>The MDCT implementation has no special characteristics. The
1536 input is a windowed signal (after pre-emphasis) of 2*N samples and the output is N
1537 frequency-domain samples. A <spanx style="emph">low-overlap</spanx> window is used to reduce the algorithmic delay. 
1538 It is derived from a basic (full overlap) window that is the same as the one used in the Vorbis codec: W(n)=[sin(pi/2*sin(pi/2*(n+.5)/L))]^2. The low-overlap window is created by zero-padding the basic window and inserting ones in the middle, such that the resulting window still satisfies power complementarity. The MDCT is computed in mdct_forward() (mdct.c), which includes the windowing operation and a scaling of 2/N.
1539 </t>
1540 </section>
1541
1542 <section anchor="normalization" title="Bands and Normalization">
1543 <t>
1544 The MDCT output is divided into bands that are designed to match the ear's critical 
1545 bands for the smallest (2.5ms) frame size. The larger frame sizes use integer
1546 multiplies of the 2.5ms layout. For each band, the encoder
1547 computes the energy that will later be encoded. Each band is then normalized by the 
1548 square root of the <spanx style="strong">non-quantized</spanx> energy, such that each band now forms a unit vector X.
1549 The energy and the normalization are computed by compute_band_energies()
1550 and normalise_bands() (bands.c), respectively.
1551 </t>
1552 </section>
1553
1554 <section anchor="energy-quantization" title="Energy Envelope Quantization">
1555
1556 <t>
1557 It is important to quantize the energy with sufficient resolution because
1558 any energy quantization error cannot be compensated for at a later
1559 stage. Regardless of the resolution used for encoding the shape of a band,
1560 it is perceptually important to preserve the energy in each band. CELT uses a
1561 coarse-fine strategy for encoding the energy in the base-2 log domain, 
1562 as implemented in quant_bands.c</t>
1563
1564 <section anchor="coarse-energy" title="Coarse energy quantization">
1565 <t>
1566 The coarse quantization of the energy uses a fixed resolution of 6 dB.
1567 To minimize the bitrate, prediction is applied both in time (using the previous frame)
1568 and in frequency (using the previous bands). The prediction using the
1569 previous frame can be disabled, creating an "intra" frame where the energy
1570 is coded without reference to prior frames. An encoder is able to choose the
1571 mode used at will based on both loss robustness and efficiency
1572 considerations.
1573 The 2-D z-transform of
1574 the prediction filter is: A(z_l, z_b)=(1-a*z_l^-1)*(1-z_b^-1)/(1-b*z_b^-1)
1575 where b is the band index and l is the frame index. The prediction coefficients
1576 applied depend on the frame size in use when not using intra energy and a=0 b=4915/32768
1577 when using intra energy.
1578 The time-domain prediction is based on the final fine quantization of the previous
1579 frame, while the frequency domain (within the current frame) prediction is based
1580 on coarse quantization only (because the fine quantization has not been computed
1581 yet). The prediction is clamped internally so that fixed point implementations with
1582 limited dynamic range to not suffer desynchronization.  Identical prediction
1583 clamping must be implemented in all encoders and decoders.
1584 We approximate the ideal
1585 probability distribution of the prediction error using a Laplace distribution
1586 with seperate parameters for each frame size in intra and inter-frame modes. The
1587 coarse energy quantization is performed by quant_coarse_energy() and 
1588 quant_coarse_energy() (quant_bands.c). The encoding of the Laplace-distributed values is
1589 implemented in ec_laplace_encode() (laplace.c).
1590 </t>
1591
1592 <!-- FIXME: bit budget consideration -->
1593 </section> <!-- coarse energy -->
1594
1595 <section anchor="fine-energy" title="Fine energy quantization">
1596 <t>
1597 After the coarse energy quantization and encoding, the bit allocation is computed 
1598 (<xref target="allocation"></xref>) and the number of bits to use for refining the
1599 energy quantization is determined for each band. Let B_i be the number of fine energy bits 
1600 for band i; the refinement is an integer f in the range [0,2^B_i-1]. The mapping between f
1601 and the correction applied to the coarse energy is equal to (f+1/2)/2^B_i - 1/2. Fine
1602 energy quantization is implemented in quant_fine_energy() 
1603 (quant_bands.c).
1604 </t>
1605
1606 <t>
1607 If any bits are unused at the end of the encoding process, these bits are used to
1608 increase the resolution of the fine energy encoding in some bands. Priority is given
1609 to the bands for which the allocation (<xref target="allocation"></xref>) was rounded
1610 down. At the same level of priority, lower bands are encoded first. Refinement bits
1611 are added until there is no more room for fine energy or until each band
1612 has gained an additional bit of precision or has the maximum fine
1613 energy precision. This is implemented in quant_energy_finalise()
1614 (quant_bands.c).
1615 </t>
1616
1617 </section> <!-- fine energy -->
1618
1619
1620 </section> <!-- Energy quant -->
1621
1622
1623 <section anchor="pvq" title="Spherical Vector Quantization">
1624 <t>CELT uses a Pyramid Vector Quantization (PVQ) <xref target="PVQ"></xref>
1625 codebook for quantizing the details of the spectrum in each band that have not
1626 been predicted by the pitch predictor. The PVQ codebook consists of all sums
1627 of K signed pulses in a vector of N samples, where two pulses at the same position
1628 are required to have the same sign. Thus the codebook includes 
1629 all integer codevectors y of N dimensions that satisfy sum(abs(y(j))) = K.
1630 </t>
1631
1632 <t>
1633 In bands where there are sufficient bits allocated the PVQ is used to encode
1634 the unit vector that results from the normalization in 
1635 <xref target="normalization"></xref> directly. Given a PVQ codevector y, 
1636 the unit vector X is obtained as X = y/||y||, where ||.|| denotes the 
1637 L2 norm.
1638 </t>
1639
1640
1641 <section anchor="pvq-search" title="PVQ Search">
1642
1643 <t>
1644 The search for the best codevector y is performed by alg_quant()
1645 (vq.c). There are several possible approaches to the 
1646 search with a tradeoff between quality and complexity. The method used in the reference
1647 implementation computes an initial codeword y1 by projecting the residual signal 
1648 R = X - p' onto the codebook pyramid of K-1 pulses:
1649 </t>
1650 <t>
1651 y0 = round_towards_zero( (K-1) * R / sum(abs(R)))
1652 </t>
1653
1654 <t>
1655 Depending on N, K and the input data, the initial codeword y0 may contain from 
1656 0 to K-1 non-zero values. All the remaining pulses, with the exception of the last one, 
1657 are found iteratively with a greedy search that minimizes the normalized correlation
1658 between y and R:
1659 </t>
1660
1661 <t>
1662 J = -R^T*y / ||y||
1663 </t>
1664
1665 <t>
1666 The search described above is considered to be a good trade-off between quality
1667 and computational cost. However, there are other possible ways to search the PVQ
1668 codebook and the implementors MAY use any other search methods.
1669 </t>
1670 </section>
1671
1672
1673 <section anchor="cwrs-encoding" title="Index Encoding">
1674 <t>
1675 The best PVQ codeword is encoded as a uniformly-distributed integer value
1676 by encode_pulses() (cwrs.c).
1677 The codeword is converted from a unique index in the same way as specified in 
1678 <xref target="PVQ"></xref>. The indexing is based on the calculation of V(N,K) 
1679 (denoted N(L,K) in <xref target="PVQ"></xref>), which is the number of possible
1680 combinations of K pulses in N samples.
1681 </t>
1682
1683 </section>
1684
1685 </section>
1686
1687
1688 <section anchor="stereo" title="Stereo support">
1689 <t>
1690 When encoding a stereo stream, some parameters are shared across the left and right channels, while others are transmitted separately for each channel, or jointly encoded. Only one copy of the flags for the features, transients and pitch (pitch
1691 period and filter parameters) are transmitted. The coarse and fine energy parameters are transmitted separately for each channel. Both the coarse energy and fine energy (including the remaining fine bits at the end of the stream) have the left and right bands interleaved in the stream, with the left band encoded first.
1692 </t>
1693
1694 <t>
1695 The main difference between mono and stereo coding is the PVQ coding of the normalized vectors. In stereo mode, a normalized mid-side (M-S) encoding is used. Let L and R be the normalized vector of a certain band for the left and right channels, respectively. The mid and side vectors are computed as M=L+R and S=L-R and no longer have unit norm.
1696 </t>
1697
1698 <t>
1699 From M and S, an angular parameter theta=2/pi*atan2(||S||, ||M||) is computed. The theta parameter is converted to a Q14 fixed-point parameter itheta, which is quantized on a scale from 0 to 1 with an interval of 2^-qb, where qb is
1700 based the number of bits allocated to the band. From here on, the value of itheta MUST be treated in a bit-exact manner since both the encoder and decoder rely on it to infer the bit allocation.
1701 </t>
1702 <t>
1703 Let m=M/||M|| and s=S/||S||; m and s are separately encoded with the PVQ encoder described in <xref target="pvq"></xref>. The number of bits allocated to m and s depends on the value of itheta.
1704 </t>
1705
1706 </section>
1707
1708
1709 <section anchor="synthesis" title="Synthesis">
1710 <t>
1711 After all the quantization is completed, the quantized energy is used along with the 
1712 quantized normalized band data to resynthesize the MDCT spectrum. The inverse MDCT (<xref target="inverse-mdct"></xref>) and the weighted overlap-add are applied and the signal is stored in the <spanx style="emph">synthesis
1713 buffer</spanx>.
1714 The encoder MAY omit this step of the processing if it does not need the decoded output.
1715 </t>
1716 </section>
1717
1718 <section anchor="vbr" title="Variable Bitrate (VBR)">
1719 <t>
1720 Each CELT frame can be encoded in a different number of octets, making it possible to vary the bitrate at will. This property can be used to implement source-controlled variable bitrate (VBR). Support for VBR is OPTIONAL for the encoder, but a decoder MUST be prepared to decode a stream that changes its bit-rate dynamically. The method used to vary the bit-rate in VBR mode is left to the implementor, as long as each frame can be decoded by the reference decoder.
1721 </t>
1722 </section>
1723
1724 </section>
1725
1726 </section>
1727
1728
1729 <section title="Conformance">
1730
1731 <t>
1732 It is the intention to allow the greatest possible choice of freedom in 
1733 implementing the specification. For this reason, outside of a few exceptions
1734 noted in this section, conformance is defined through the reference
1735 implementation of the decoder provided in Appendix <xref target="ref-implementation"></xref>.
1736 Although this document includes an English description of the codec, should 
1737 the description contradict the source code of the reference implementation, 
1738 the latter shall take precedence.
1739 </t>
1740
1741 <t>
1742 Compliance with this specification means that a decoder's output MUST be
1743 within the thresholds specified compared to the reference implementation
1744 using the opus_compare.m tool in Appendix <xref
1745 target="opus-compare"></xref>.
1746 </t>
1747 </section>
1748
1749 <section anchor="security" title="Security Considerations">
1750
1751 <t>
1752 The codec needs to take appropriate security considerations 
1753 into account, as outlined in <xref target="DOS"/> and <xref target="SECGUIDE"/>.
1754 It is extremely important for the decoder to be robust against malicious
1755 payloads. Malicious payloads must not cause the decoder to overrun its
1756 allocated memory or to take much more resources to decode. Although problems
1757 in encoders are typically rarer, the same applies to the encoder. Malicious
1758 audio stream must not cause the encoder to misbehave because this would
1759 allow an attacker to attack transcoding gateways.
1760 </t>
1761 <t>
1762 The reference implementation contains no known buffer overflow or cases where
1763 a specially crafter packet or audio segment could cause a significant increase
1764 in CPU load. However, on certain CPU architectures where denormalized 
1765 floating-point operations are much slower it is possible for some audio content
1766 (e.g. silence or near-silence) to cause such an increase
1767 in CPU load. For such architectures, it is RECOMMENDED to add very small
1768 floating-point offsets to prevent significant numbers of denormalized
1769 operations or to configure the hardware to zeroize denormal numbers.
1770 No such issue exists for the fixed-point reference implementation.
1771 </t>
1772 </section> 
1773
1774
1775 <section title="IANA Considerations ">
1776 <t>
1777 This document has no actions for IANA.
1778 </t>
1779 </section>
1780
1781 <section anchor="Acknowledgments" title="Acknowledgments">
1782 <t>
1783 Thanks to all other developers, including Raymond Chen, Soeren Skak Jensen, Gregory Maxwell, 
1784 Christopher Montgomery, Karsten Vandborg Soerensen, and Timothy Terriberry.
1785 </t>
1786 </section> 
1787
1788 </middle>
1789
1790 <back>
1791
1792 <references title="Informative References">
1793
1794 <reference anchor='SILK'>
1795 <front>
1796 <title>SILK Speech Codec</title>
1797 <author initials='K.' surname='Vos' fullname='K. Vos'>
1798 <organization /></author>
1799 <author initials='S.' surname='Jensen' fullname='S. Jensen'>
1800 <organization /></author>
1801 <author initials='K.' surname='Soerensen' fullname='K. Soerensen'>
1802 <organization /></author>
1803 <date year='2010' month='March' />
1804 <abstract>
1805 <t></t>
1806 </abstract></front>
1807 <seriesInfo name='Internet-Draft' value='draft-vos-silk-01' />
1808 <format type='TXT' target='http://tools.ietf.org/html/draft-vos-silk-01' />
1809 </reference>
1810
1811       <reference anchor="laroia-icassp">
1812         <front>
1813           <title abbrev="Robust and Efficient Quantization of Speech LSP">
1814             Robust and Efficient Quantization of Speech LSP Parameters Using Structured Vector Quantization
1815           </title>
1816           <author initials="R.L." surname="Laroia" fullname="R.">
1817             <organization/>
1818           </author>
1819           <author initials="N.P." surname="Phamdo" fullname="N.">
1820             <organization/>
1821           </author>
1822           <author initials="N.F." surname="Farvardin" fullname="N.">
1823             <organization/>
1824           </author>
1825         </front>
1826         <seriesInfo name="ICASSP-1991, Proc. IEEE Int. Conf. Acoust., Speech, Signal Processing, pp. 641-644, October" value="1991"/>
1827       </reference>
1828
1829       <reference anchor="sinervo-norsig">
1830         <front>
1831           <title abbrev="SVQ versus MSVQ">Evaluation of Split and Multistage Techniques in LSF Quantization</title>
1832           <author initials="U.S." surname="Sinervo" fullname="Ulpu Sinervo">
1833             <organization/>
1834           </author>
1835           <author initials="J.N." surname="Nurminen" fullname="Jani Nurminen">
1836             <organization/>
1837           </author>
1838           <author initials="A.H." surname="Heikkinen" fullname="Ari Heikkinen">
1839             <organization/>
1840           </author>
1841           <author initials="J.S." surname="Saarinen" fullname="Jukka Saarinen">
1842             <organization/>
1843           </author>
1844         </front>
1845         <seriesInfo name="NORSIG-2001, Norsk symposium i signalbehandling, Trondheim, Norge, October" value="2001"/>
1846       </reference>
1847
1848       <reference anchor="leblanc-tsap">
1849         <front>
1850           <title>Efficient Search and Design Procedures for Robust Multi-Stage VQ of LPC Parameters for 4 kb/s Speech Coding</title>
1851           <author initials="W.P." surname="LeBlanc" fullname="">
1852             <organization/>
1853           </author>
1854           <author initials="B." surname="Bhattacharya" fullname="">
1855             <organization/>
1856           </author>
1857           <author initials="S.A." surname="Mahmoud" fullname="">
1858             <organization/>
1859           </author>
1860           <author initials="V." surname="Cuperman" fullname="">
1861             <organization/>
1862           </author>
1863         </front>
1864         <seriesInfo name="IEEE Transactions on Speech and Audio Processing, Vol. 1, No. 4, October" value="1993" />
1865       </reference>
1866
1867 <reference anchor='CELT'>
1868 <front>
1869 <title>Constrained-Energy Lapped Transform (CELT) Codec</title>
1870 <author initials='J-M.' surname='Valin' fullname='J-M. Valin'>
1871 <organization /></author>
1872 <author initials='T.' surname='Terriberry' fullname='T. Terriberry'>
1873 <organization /></author>
1874 <author initials='G.' surname='Maxwell' fullname='G. Maxwell'>
1875 <organization /></author>
1876 <author initials='C.' surname='Montgomery' fullname='C. Montgomery'>
1877 <organization /></author>
1878 <date year='2010' month='July' />
1879 <abstract>
1880 <t></t>
1881 </abstract></front>
1882 <seriesInfo name='Internet-Draft' value='draft-valin-celt-codec-02' />
1883 <format type='TXT' target='http://tools.ietf.org/html/draft-valin-celt-codec-02' />
1884 </reference>
1885
1886 <reference anchor='DOS'>
1887 <front>
1888 <title>Internet Denial-of-Service Considerations</title>
1889 <author initials='M.' surname='Handley' fullname='M. Handley'>
1890 <organization /></author>
1891 <author initials='E.' surname='Rescorla' fullname='E. Rescorla'>
1892 <organization /></author>
1893 <author>
1894 <organization>IAB</organization></author>
1895 <date year='2006' month='December' />
1896 <abstract>
1897 <t>This document provides an overview of possible avenues for denial-of-service (DoS) attack on Internet systems.  The aim is to encourage protocol designers and network engineers towards designs that are more robust.  We discuss partial solutions that reduce the effectiveness of attacks, and how some solutions might inadvertently open up alternative vulnerabilities.  This memo provides information for the Internet community.</t></abstract></front>
1898 <seriesInfo name='RFC' value='4732' />
1899 <format type='TXT' octets='91844' target='ftp://ftp.isi.edu/in-notes/rfc4732.txt' />
1900 </reference>
1901
1902 <reference anchor='SECGUIDE'>
1903 <front>
1904 <title>Guidelines for Writing RFC Text on Security Considerations</title>
1905 <author initials='E.' surname='Rescorla' fullname='E. Rescorla'>
1906 <organization /></author>
1907 <author initials='B.' surname='Korver' fullname='B. Korver'>
1908 <organization /></author>
1909 <date year='2003' month='July' />
1910 <abstract>
1911 <t>All RFCs are required to have a Security Considerations section.  Historically, such sections have been relatively weak.  This document provides guidelines to RFC authors on how to write a good Security Considerations section.  This document specifies an Internet Best Current Practices for the Internet Community, and requests discussion and suggestions for improvements.</t></abstract></front>
1912
1913 <seriesInfo name='BCP' value='72' />
1914 <seriesInfo name='RFC' value='3552' />
1915 <format type='TXT' octets='110393' target='ftp://ftp.isi.edu/in-notes/rfc3552.txt' />
1916 </reference>
1917
1918 <reference anchor="range-coding">
1919 <front>
1920 <title>Range encoding: An algorithm for removing redundancy from a digitised message</title>
1921 <author initials="G." surname="Nigel" fullname=""><organization/></author>
1922 <author initials="N." surname="Martin" fullname=""><organization/></author>
1923 <date year="1979" />
1924 </front>
1925 <seriesInfo name="Proc. Institution of Electronic and Radio Engineers International Conference on Video and Data Recording" value="" />
1926 </reference> 
1927
1928 <reference anchor="coding-thesis">
1929 <front>
1930 <title>Source coding algorithms for fast data compression</title>
1931 <author initials="R." surname="Pasco" fullname=""><organization/></author>
1932 <date month="May" year="1976" />
1933 </front>
1934 <seriesInfo name="Ph.D. thesis" value="Dept. of Electrical Engineering, Stanford University" />
1935 </reference>
1936
1937 <reference anchor="PVQ">
1938 <front>
1939 <title>A Pyramid Vector Quantizer</title>
1940 <author initials="T." surname="Fischer" fullname=""><organization/></author>
1941 <date month="July" year="1986" />
1942 </front>
1943 <seriesInfo name="IEEE Trans. on Information Theory, Vol. 32" value="pp. 568-583" />
1944 </reference> 
1945
1946 </references> 
1947
1948 <section anchor="ref-implementation" title="Reference Implementation">
1949
1950 <t>This appendix contains the complete source code for the
1951 reference implementation of the Opus codec written in C. This
1952 implementation can be compiled for 
1953 either floating-point or fixed-point architectures.
1954 </t>
1955
1956 <t>The implementation can be compiled with either a C89 or a C99
1957 compiler. It is reasonably optimized for most platforms such that
1958 only architecture-specific optimizations are likely to be useful.
1959 The FFT used is a slightly modified version of the KISS-FFT package,
1960 but it is easy to substitute any other FFT library.
1961 </t>
1962
1963 <section title="Extracting the source">
1964 <t>
1965 The complete source code can be extracted from this draft, by running the
1966 following command line:
1967
1968 <list style="symbols">
1969 <t><![CDATA[
1970 cat draft-ietf-codec-opus.txt | grep '^\ \ \ ###' | sed 's/\s\s\s###//' | base64 -d > opus_source.tar.gz
1971 ]]></t>
1972 <t>
1973 tar xzvf opus_source.tar.gz
1974 </t>
1975 <t>cd opus_source</t>
1976 <t>make</t>
1977 </list>
1978
1979 </t>
1980 </section>
1981
1982 <section title="Base64-encoded source code">
1983 <t>
1984 <?rfc include="opus_source.base64"?>
1985 </t>
1986 </section>
1987
1988 </section>
1989
1990 <section anchor="opus-compare" title="opus_compare.m">
1991 <t>
1992 <?rfc include="opus_compare_escaped.m"?>
1993 </t>
1994 </section>
1995
1996 </back>
1997
1998 </rfc>