Update TOC byte
[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-02">
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="14" month="November" year="2010" />
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>The implementation of SILK-based LP layer is similar to the description in
96 the <xref target="SILK">SILK Internet-Draft</xref> with the main exception that 
97 SILK was modified to 
98 use the same range coder as CELT. The implementation of the CELT-based MDCT
99 layer is available from the CELT website and is a more recent version (0.8.1) 
100 of the <xref target="CELT">CELT Internet-Draft</xref>. 
101 The main changes
102 include better support for 20 ms frames as well as the ability to encode 
103 only the higher bands using a range coder partially filled by the SILK layer.</t>
104
105 <t>
106 In addition to their frame size, the SILK and CELT codecs require
107 a look-ahead of 5.2 ms and 2.5 ms, respectively. SILK's look-ahead is due to
108 noise shaping estimation (5 ms) and the internal resampling (0.2 ms), while
109 CELT's look-ahead is due to the overlapping MDCT windows. To compensate for the
110 difference, the CELT encoder input is delayed by 2.7 ms. This ensures that low
111 frequencies and high frequencies arrive at the same time.
112 </t>
113
114
115 <section title="Source Code">
116 <t>
117 The source code is currently available in a
118 <eref target='git://git.xiph.org/users/jm/ietfcodec.git'>Git repository</eref> 
119 which references two other
120 repositories (for SILK and CELT). Some snapshots are provided for 
121 convenience at <eref target='http://people.xiph.org/~jm/ietfcodec/'/> along
122 with sample files.
123 Although the build system is very primitive, some instructions are provided 
124 in the toplevel README file.
125 This is very early development so both the quality and feature set should
126 greatly improve over time. In the current version, only 48 kHz audio is 
127 supported, but support for all configurations listed in 
128 <xref target="modes"></xref> is planned. 
129 </t>
130 </section>
131
132 </section>
133
134 <section anchor="modes" title="Codec Modes">
135 <t>
136 There are three possible operating modes for the proposed prototype:
137 <list style="numbers">
138 <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>
139 <t>A hybrid (LP+MDCT) mode for full-bandwidth speech at medium bitrates</t>
140 <t>An MDCT-only mode for very low delay speech transmission as well as music transmission.</t>
141 </list>
142 Each of these modes supports a number of difference frame sizes and sampling
143 rates. In order to distinguish between the various modes and configurations,
144 we define a single-byte table-of-contents (TOC) header that can used in the transport layer 
145 (e.g RTP) to signal this information. The following describes the proposed
146 TOC byte.
147 </t>
148
149 <t>
150 The LP mode supports the following configurations (numbered from 0 to 11):
151 <list style="symbols">
152 <t>8 kHz:  10, 20, 40, 60 ms (0..3)</t>
153 <t>12 kHz: 10, 20, 40, 60 ms (4..7)</t>
154 <t>16 kHz: 10, 20, 40, 60 ms (8..11)</t>
155 </list>
156 for a total of 12 configurations.
157 </t>
158
159 <t>
160 The hybrid mode supports the following configurations (numbered from 12 to 15):
161 <list style="symbols">
162 <t>32 kHz: 10, 20 ms (12..13)</t>
163 <t>48 kHz: 10, 20 ms (14..15)</t>
164 </list>
165 for a total of 4 configurations.
166 </t>
167
168 <t>
169 The MDCT-only mode supports the following configurations (numbered from 16 to 31):
170 <list style="symbols">
171 <t>8 kHz:  2.5, 5, 10, 20 ms (16..19)</t>
172 <t>16 kHz: 2.5, 5, 10, 20 ms (20..23)</t>
173 <t>32 kHz: 2.5, 5, 10, 20 ms (24..27)</t>
174 <t>48 kHz: 2.5, 5, 10, 20 ms (28..31)</t>
175 </list>
176 for a total of 16 configurations.
177 </t>
178
179 <t>
180 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):
181 <list style="symbols">
182 <t>0:    1 frames in the packet</t>
183 <t>1:    2 frames in the packet, each with equal compressed size</t>
184 <t>2:    arbitrary number of frames in the packet, each with equal compressed size</t>
185 <t>3:    arbitrary number of frames in the packet, with different compressed sizes</t>
186 </list>
187 For codes 2 and 3, the TOC byte is followed by the number of frames in the packet. 
188 For code 3, the byte indicating the number of frames is followed by N-1 frame 
189 lengths encoded as described below. As an additional limit, the audio duration contained
190 within a packet may not exceed 120 ms.
191 </t>
192
193 <t>
194 The compressed size of the frames (if needed) is indicated -- usually -- with one byte, with the following meaning:
195 <list style="symbols">
196 <t>0:          No frame (DTX or lost packet)</t>
197 <t>1-251:      Size of the frame in bytes</t>
198 <t>252-255:    A second byte is needed. The total size is (size[1]*4)+size[0]</t>
199 </list>
200 </t>
201
202 <t>
203 The maximum size representable is 255*4+255=1275 bytes. For 20 ms frames, that 
204 represents a bit-rate of 510 kb/s, which is really the highest rate anyone would want 
205 to use in stereo mode (beyond that point, lossless codecs would be more appropriate).
206 </t>
207
208 <section anchor="examples" title="Examples">
209 <t>
210 Simplest case: one narrowband mono 20-ms SILK frame
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 |    1    |0|0|0|               compressed data...              |
220 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
221 ]]></artwork>
222 </figure>
223 </t>
224
225 <t>
226 Two 48 kHz mono 5 ms CELT frames of the same 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 |    29   |0|0|1|               compressed data...              |
236 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
237 ]]></artwork>
238 </figure>
239 </t>
240
241 <t>
242 Two 48 kHz mono 20-ms hybrid frames of different compressed size:
243 </t>
244
245 <t>
246 <figure>
247 <artwork><![CDATA[
248  0                   1                   2                   3
249  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
250 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
251 |    15   |0|1|1|       2       |   frame size  |compressed data|
252 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
253 |                       compressed data...                      |
254 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
255 ]]></artwork>
256 </figure>
257 </t>
258
259 <t>
260 Four 48 kHz stereo 20-ms CELT frame of the same compressed size:
261
262 </t>
263
264 <t>
265 <figure>
266 <artwork><![CDATA[
267  0                   1                   2                   3
268  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
269 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
270 |    31   |1|1|0|       4       |      compressed data...       |
271 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
272 ]]></artwork>
273 </figure>
274 </t>
275 </section>
276
277
278 </section>
279
280 <section title="Codec Encoder">
281 <t>
282 Opus encoder block diagram.
283 </t>
284
285 <section anchor="range-encoder" title="Range Coder">
286 <t>
287 Opus uses an entropy coder based upon <xref target="range-coding"></xref>, 
288 which is itself a rediscovery of the FIFO arithmetic code introduced by <xref target="coding-thesis"></xref>.
289 It is very similar to arithmetic encoding, except that encoding is done with
290 digits in any base instead of with bits, 
291 so it is faster when using larger bases (i.e.: an octet). All of the
292 calculations in the range coder must use bit-exact integer arithmetic.
293 </t>
294
295 <t>
296 The range coder also acts as the bit-packer for Opus. It is
297 used in three different ways, to encode:
298 <list style="symbols">
299 <t>entropy-coded symbols with a fixed probability model using ec_encode(), (rangeenc.c)</t>
300 <t>integers from 0 to 2^M-1 using ec_enc_uint() or ec_enc_bits(), (entenc.c)</t>
301 <t>integers from 0 to N-1 (where N is not a power of two) using ec_enc_uint(). (entenc.c)</t>
302 </list>
303 </t>
304
305 <t>
306 The range encoder maintains an internal state vector composed of the
307 four-tuple (low,rng,rem,ext), representing the low end of the current
308 range, the size of the current range, a single buffered output octet,
309 and a count of additional carry-propagating output octets. Both rng
310 and low are 32-bit unsigned integer values, rem is an octet value or
311 the special value -1, and ext is an integer with at least 16 bits.
312 This state vector is initialized at the start of each each frame to
313 the value (0,2^31,-1,0).
314 </t>
315
316 <t>
317 Each symbol is drawn from a finite alphabet and coded in a separate
318 context which describes the size of the alphabet and the relative
319 frequency of each symbol in that alphabet. Opus only uses static
320 contexts; they are not adapted to the statistics of the data that is
321 coded.
322 </t>
323
324 <section anchor="encoding-symbols" title="Encoding Symbols">
325 <t>
326    The main encoding function is ec_encode() (rangeenc.c),
327    which takes as an argument a three-tuple (fl,fh,ft)
328    describing the range of the symbol to be encoded in the current
329    context, with 0 &lt;= fl &lt; fh &lt;= ft &lt;= 65535. The values of this tuple
330    are derived from the probability model for the symbol. Let f(i) be
331    the frequency of the ith symbol in the current context. Then the
332    three-tuple corresponding to the kth symbol is given by
333    <![CDATA[
334 fl=sum(f(i),i<k), fh=fl+f(i), and ft=sum(f(i)).
335 ]]>
336 </t>
337 <t>
338    ec_encode() updates the state of the encoder as follows. If fl is
339    greater than zero, then low = low + rng - (rng/ft)*(ft-fl) and 
340    rng = (rng/ft)*(fh-fl). Otherwise, low is unchanged and
341    rng = rng - (rng/ft)*(fh-fl). The divisions here are exact integer
342    division. After this update, the range is normalized.
343 </t>
344 <t>
345    To normalize the range, the following process is repeated until
346    rng > 2^23. First, the top 9 bits of low, (low>>23), are placed into
347    a carry buffer. Then, low is set to <![CDATA[(low << 8 & 0x7FFFFFFF) and rng
348    is set to (rng<<8)]]>. This process is carried out by
349    ec_enc_normalize() (rangeenc.c).
350 </t>
351 <t>
352    The 9 bits produced in each iteration of the normalization loop
353    consist of 8 data bits and a carry flag. The final value of the
354    output bits is not determined until carry propagation is accounted
355    for. Therefore the reference implementation buffers a single
356    (non-propagating) output octet and keeps a count of additional
357    propagating (0xFF) output octets. An implementation MAY choose to use
358    any mathematically equivalent scheme to perform carry propagation.
359 </t>
360 <t>
361    The function ec_enc_carry_out() (rangeenc.c) performs
362    this buffering. It takes a 9-bit input value, c, from the normalization
363    8-bit output and a carry bit. If c is 0xFF, then ext is incremented
364    and no octets are output. Otherwise, if rem is not the special value
365    -1, then the octet (rem+(c>>8)) is output. Then ext octets are output
366    with the value 0 if the carry bit is set, or 0xFF if it is not, and
367    rem is set to the lower 8 bits of c. After this, ext is set to zero.
368 </t>
369 <t>
370    In the reference implementation, a special version of ec_encode()
371    called ec_encode_bin() (rangeenc.c) is defined to
372    take a two-tuple (fl,ftb), where <![CDATA[0 <= fl < 2^ftb and ftb < 16. It is
373    mathematically equivalent to calling ec_encode() with the three-tuple
374    (fl,fl+1,1<<ftb)]]>, but avoids using division.
375
376 </t>
377 </section>
378
379 <section anchor="encoding-ints" title="Encoding Uniformly Distributed Integers">
380 <t>
381    Functions ec_enc_uint() or ec_enc_bits() are based on ec_encode() and 
382    encode one of N equiprobable symbols, each with a frequency of 1,
383    where N may be as large as 2^32-1. Because ec_encode() is limited to
384    a total frequency of 2^16-1, this is done by encoding a series of
385    symbols in smaller contexts.
386 </t>
387 <t>
388    ec_enc_bits() (entenc.c) is defined, like
389    ec_encode_bin(), to take a two-tuple (fl,ftb), with <![CDATA[0 <= fl < 2^ftb
390    and ftb < 32. While ftb is greater than 8, it encodes bits (ftb-8) to
391    (ftb-1) of fl, e.g., (fl>>ftb-8&0xFF) using ec_encode_bin() and
392    subtracts 8 from ftb. Then, it encodes the remaining bits of fl, e.g.,
393    (fl&(1<<ftb)-1)]]>, again using ec_encode_bin().
394 </t>
395 <t>
396    ec_enc_uint() (entenc.c) takes a two-tuple (fl,ft),
397    where ft is not necessarily a power of two. Let ftb be the location
398    of the highest 1 bit in the two's-complement representation of
399    (ft-1), or -1 if no bits are set. If ftb>8, then the top 8 bits of fl
400    are encoded using ec_encode() with the three-tuple
401    (fl>>ftb-8,(fl>>ftb-8)+1,(ft-1>>ftb-8)+1), and the remaining bits
402    are encoded with ec_enc_bits using the two-tuple
403    <![CDATA[(fl&(1<<ftb-8)-1,ftb-8). Otherwise, fl is encoded with ec_encode()
404    directly using the three-tuple (fl,fl+1,ft)]]>.
405 </t>
406 </section>
407
408 <section anchor="encoder-finalizing" title="Finalizing the Stream">
409 <t>
410    After all symbols are encoded, the stream must be finalized by
411    outputting a value inside the current range. Let end be the integer
412    in the interval [low,low+rng) with the largest number of trailing
413    zero bits. Then while end is not zero, the top 9 bits of end, e.g.,
414    <![CDATA[(end>>23), are sent to the carry buffer, and end is replaced by
415    (end<<8&0x7FFFFFFF). Finally, if the value in carry buffer, rem, is]]>
416    neither zero nor the special value -1, or the carry count, ext, is
417    greater than zero, then 9 zero bits are sent to the carry buffer.
418    After the carry buffer is finished outputting octets, the rest of the
419    output buffer is padded with zero octets. Finally, rem is set to the
420    special value -1. This process is implemented by ec_enc_done()
421    (rangeenc.c).
422 </t>
423 </section>
424
425 <section anchor="encoder-tell" title="Current Bit Usage">
426 <t>
427    The bit allocation routines in Opus need to be able to determine a
428    conservative upper bound on the number of bits that have been used
429    to encode the current frame thus far. This drives allocation
430    decisions and ensures that the range code will not overflow the
431    output buffer. This is computed in the reference implementation to
432    fractional bit precision by the function ec_enc_tell() 
433    (rangeenc.c).
434    Like all operations in the range encoder, it must
435    be implemented in a bit-exact manner.
436 </t>
437 </section>
438
439 </section>
440
441 <section title="SILK Encoder">
442 <t>
443 Copy from SILK draft.
444 </t>
445 </section>
446
447 <section title="CELT Encoder">
448 <t>
449 Copy from CELT draft.
450 </t>
451
452 <section anchor="forward-mdct" title="Forward MDCT">
453
454 <t>The MDCT implementation has no special characteristics. The
455 input is a windowed signal (after pre-emphasis) of 2*N samples and the output is N
456 frequency-domain samples. A <spanx style="emph">low-overlap</spanx> window is used to reduce the algorithmic delay. 
457 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.
458 </t>
459 </section>
460
461 <section anchor="normalization" title="Bands and Normalization">
462 <t>
463 The MDCT output is divided into bands that are designed to match the ear's critical bands,
464 with the exception that each band has to be at least 3 bins wide. For each band, the encoder
465 computes the energy that will later be encoded. Each band is then normalized by the 
466 square root of the <spanx style="strong">non-quantized</spanx> energy, such that each band now forms a unit vector X.
467 The energy and the normalization are computed by compute_band_energies()
468 and normalise_bands() (bands.c), respectively.
469 </t>
470 </section>
471
472 <section anchor="energy-quantization" title="Energy Envelope Quantization">
473
474 <t>
475 It is important to quantize the energy with sufficient resolution because
476 any energy quantization error cannot be compensated for at a later
477 stage. Regardless of the resolution used for encoding the shape of a band,
478 it is perceptually important to preserve the energy in each band. CELT uses a
479 coarse-fine strategy for encoding the energy in the base-2 log domain, 
480 as implemented in quant_bands.c</t>
481
482 <section anchor="coarse-energy" title="Coarse energy quantization">
483 <t>
484 The coarse quantization of the energy uses a fixed resolution of
485 6 dB and is the only place where entropy coding is used.
486 To minimize the bitrate, prediction is applied both in time (using the previous frame)
487 and in frequency (using the previous bands). The 2-D z-transform of
488 the prediction filter is: A(z_l, z_b)=(1-a*z_l^-1)*(1-z_b^-1)/(1-b*z_b^-1)
489 where b is the band index and l is the frame index. The prediction coefficients are
490 a=0.8 and b=0.7 when not using intra energy and a=b=0 when using intra energy. 
491 The time-domain prediction is based on the final fine quantization of the previous
492 frame, while the frequency domain (within the current frame) prediction is based
493 on coarse quantization only (because the fine quantization has not been computed
494 yet). We approximate the ideal 
495 probability distribution of the prediction error using a Laplace distribution. The
496 coarse energy quantization is performed by quant_coarse_energy() and 
497 quant_coarse_energy() (quant_bands.c).
498 </t>
499
500 <t>
501 The Laplace distribution for each band is defined by a 16-bit (Q15) decay parameter.
502 Thus, the value 0 has a frequency count of p[0]=2*(16384*(16384-decay)/(16384+decay)). The 
503 values +/- i each have a frequency count p[i] = (p[i-1]*decay)>>14. The value of p[i] is always
504 rounded down (to avoid exceeding 32768 as the sum of all frequency counts), so it is possible
505 for the sum to be less than 32768. In that case additional values with a frequency count of 1 are encoded. The signed values corresponding to symbols 0, 1, 2, 3, 4, ... 
506 are [0, +1, -1, +2, -2, ...]. The encoding of the Laplace-distributed values is 
507 implemented in ec_laplace_encode() (laplace.c).
508 </t>
509 <!-- FIXME: bit budget consideration -->
510 </section> <!-- coarse energy -->
511
512 <section anchor="fine-energy" title="Fine energy quantization">
513 <t>
514 After the coarse energy quantization and encoding, the bit allocation is computed 
515 (<xref target="allocation"></xref>) and the number of bits to use for refining the
516 energy quantization is determined for each band. Let B_i be the number of fine energy bits 
517 for band i; the refinement is an integer f in the range [0,2^B_i-1]. The mapping between f
518 and the correction applied to the coarse energy is equal to (f+1/2)/2^B_i - 1/2. Fine
519 energy quantization is implemented in quant_fine_energy() 
520 (quant_bands.c).
521 </t>
522
523 <t>
524 If any bits are unused at the end of the encoding process, these bits are used to
525 increase the resolution of the fine energy encoding in some bands. Priority is given
526 to the bands for which the allocation (<xref target="allocation"></xref>) was rounded
527 down. At the same level of priority, lower bands are encoded first. Refinement bits
528 are added until there are no unused bits. This is implemented in quant_energy_finalise() 
529 (quant_bands.c).
530 </t>
531
532 </section> <!-- fine energy -->
533
534
535 </section> <!-- Energy quant -->
536
537 <section anchor="allocation" title="Bit Allocation">
538 <t>Bit allocation is performed based only on information available to both
539 the encoder and decoder. The same calculations are performed in a bit-exact
540 manner in both the encoder and decoder to ensure that the result is always
541 exactly the same. Any mismatch would cause an error in the decoded output.
542 The allocation is computed by compute_allocation() (rate.c),
543 which is used in both the encoder and the decoder.</t>
544
545 <t>For a given band, the bit allocation is nearly constant across
546 frames that use the same number of bits for Q1, yielding a 
547 pre-defined signal-to-mask ratio (SMR) for each band. Because the
548 bands each have a width of one Bark, this is equivalent to modeling the
549 masking occurring within each critical band, while ignoring inter-band
550 masking and tone-vs-noise characteristics. While this is not an
551 optimal bit allocation, it provides good results without requiring the
552 transmission of any allocation information.
553 </t>
554
555
556 <t>
557 For every encoded or decoded frame, a target allocation must be computed
558 using the projected allocation. In the reference implementation this is
559 performed by compute_allocation() (rate.c).
560 The target computation begins by calculating the available space as the
561 number of whole bits which can be fit in the frame after Q1 is stored according
562 to the range coder (ec_[enc/dec]_tell()) and then multiplying by 8.
563 Then the two projected prototype allocations whose sums multiplied by 8 are nearest
564 to that value are determined. These two projected prototype allocations are then interpolated
565 by finding the highest integer interpolation coefficient in the range 0-8
566 such that the sum of the higher prototype times the coefficient, plus the
567 sum of the lower prototype multiplied by
568 the difference of 16 and the coefficient, is less than or equal to the
569 available sixteenth-bits. 
570 The reference implementation performs this step using a binary search in
571 interp_bits2pulses() (rate.c). The target  
572 allocation is the interpolation coefficient times the higher prototype, plus
573 the lower prototype multiplied by the difference of 16 and the coefficient,
574 for each of the CELT bands.   
575 </t>
576
577 <t>
578 Because the computed target will sometimes be somewhat smaller than the
579 available space, the excess space is divided by the number of bands, and this amount
580 is added equally to each band. Any remaining space is added to the target one
581 sixteenth-bit at a time, starting from the first band. The new target now
582 matches the available space, in sixteenth-bits, exactly. 
583 </t>
584
585 <t>
586 The allocation target is separated into a portion used for fine energy
587 and a portion used for the Spherical Vector Quantizer (PVQ). The fine energy
588 quantizer operates in whole-bit steps. For each band the number of bits per 
589 channel used for fine energy is calculated by 50 minus the log2_frac(), with
590 1/16 bit precision, of the number of MDCT bins in the band. That result is multiplied
591 by the number of bins in the band and again by twice the number of                 
592 channels, and then the value is set to zero if it is less than zero. Added
593 to that result is 16 times the number of MDCT bins times the number of
594 channels,  and it is finally divided by 32 times the number of MDCT bins times the
595 number of channels. If the result times the number of channels is greater than than the
596 target divided by 16, the result is set to the target divided by the number of
597 channels divided by 16. Then if the value is greater than 7 it is reset to 7 because a
598 larger amount of fine energy resolution was determined not to be make an improvement in
599 perceived quality.  The resulting number of fine energy bits per channel is
600 then multiplied by the number of channels and then by 16, and subtracted
601 from the target allocation. This final target allocation is what is used for the
602 PVQ.
603 </t>
604
605 </section>
606
607 <section anchor="pitch-prediction" title="Pitch Prediction">
608 <t>
609 This section needs to be updated.
610 </t>
611
612 </section>
613
614 <section anchor="pvq" title="Spherical Vector Quantization">
615 <t>CELT uses a Pyramid Vector Quantization (PVQ) <xref target="PVQ"></xref>
616 codebook for quantizing the details of the spectrum in each band that have not
617 been predicted by the pitch predictor. The PVQ codebook consists of all sums
618 of K signed pulses in a vector of N samples, where two pulses at the same position
619 are required to have the same sign. Thus the codebook includes 
620 all integer codevectors y of N dimensions that satisfy sum(abs(y(j))) = K.
621 </t>
622
623 <t>
624 In bands where neither pitch nor folding is used, the PVQ is used to encode
625 the unit vector that results from the normalization in 
626 <xref target="normalization"></xref> directly. Given a PVQ codevector y, 
627 the unit vector X is obtained as X = y/||y||, where ||.|| denotes the 
628 L2 norm.
629 </t>
630
631 <section anchor="bits-pulses" title="Bits to Pulses">
632 <t>
633 Although the allocation is performed in 1/16 bit units, the quantization requires
634 an integer number of pulses K. To do this, the encoder searches for the value
635 of K that produces the number of bits that is the nearest to the allocated value
636 (rounding down if exactly half-way between two values), subject to not exceeding
637 the total number of bits available. The computation is performed in 1/16 of
638 bits using log2_frac() and ec_enc_tell(). The number of codebooks entries can
639 be computed as explained in <xref target="cwrs-encoding"></xref>. The difference
640 between the number of bits allocated and the number of bits used is accumulated to a
641 <spanx style="emph">balance</spanx> (initialised to zero) that helps adjusting the
642 allocation for the next bands. One third of the balance is subtracted from the
643 bit allocation of the next band to help achieving the target allocation. The only
644 exceptions are the band before the last and the last band, for which half the balance
645 and the whole balance are subtracted, respectively.
646 </t>
647 </section>
648
649 <section anchor="pvq-search" title="PVQ Search">
650
651 <t>
652 The search for the best codevector y is performed by alg_quant()
653 (vq.c). There are several possible approaches to the 
654 search with a tradeoff between quality and complexity. The method used in the reference
655 implementation computes an initial codeword y1 by projecting the residual signal 
656 R = X - p' onto the codebook pyramid of K-1 pulses:
657 </t>
658 <t>
659 y0 = round_towards_zero( (K-1) * R / sum(abs(R)))
660 </t>
661
662 <t>
663 Depending on N, K and the input data, the initial codeword y0 may contain from 
664 0 to K-1 non-zero values. All the remaining pulses, with the exception of the last one, 
665 are found iteratively with a greedy search that minimizes the normalized correlation
666 between y and R:
667 </t>
668
669 <t>
670 J = -R^T*y / ||y||
671 </t>
672
673 <t>
674 The search described above is considered to be a good trade-off between quality
675 and computational cost. However, there are other possible ways to search the PVQ
676 codebook and the implementors MAY use any other search methods.
677 </t>
678 </section>
679
680
681 <section anchor="cwrs-encoding" title="Index Encoding">
682 <t>
683 The best PVQ codeword is encoded as a uniformly-distributed integer value
684 by encode_pulses() (cwrs.c).
685 The codeword is converted to a unique index in the same way as specified in 
686 <xref target="PVQ"></xref>. The indexing is based on the calculation of V(N,K) (denoted N(L,K) in <xref target="PVQ"></xref>), which is the number of possible combinations of K pulses 
687 in N samples. The number of combinations can be computed recursively as 
688 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. 
689 There are many different ways to compute V(N,K), including pre-computed tables and direct
690 use of the recursive formulation. The reference implementation applies the recursive
691 formulation one line (or column) at a time to save on memory use,
692 along with an alternate,
693 univariate recurrence to initialise an arbitrary line, and direct
694 polynomial solutions for small N. All of these methods are
695 equivalent, and have different trade-offs in speed, memory usage, and
696 code size. Implementations MAY use any methods they like, as long as
697 they are equivalent to the mathematical definition.
698 </t>
699
700 <t>
701 The indexing computations are performed using 32-bit unsigned integers. For large codebooks,
702 32-bit integers are not sufficient. Instead of using 64-bit integers (or more), the encoding
703 is made slightly sub-optimal by splitting each band into two equal (or near-equal) vectors of
704 size (N+1)/2 and N/2, respectively. The number of pulses in the first half, K1, is first encoded as an
705 integer in the range [0,K]. Then, two codebooks are encoded with V((N+1)/2, K1) and V(N/2, K-K1). 
706 The split operation is performed recursively, in case one (or both) of the split vectors 
707 still requires more than 32 bits. For compatibility reasons, the handling of codebooks of more 
708 than 32 bits MUST be implemented with the splitting method, even if 64-bit arithmetic is available.
709 </t>
710 </section>
711
712 </section>
713
714
715 <section anchor="stereo" title="Stereo support">
716 <t>
717 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 period and gains) 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.
718 </t>
719
720 <t>
721 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.
722 </t>
723
724 <t>
725 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 = (b-2*(N-1)*(40-log2_frac(N,4)))/(32*(N-1)), b is the number of bits allocated to the band, and log2_frac() is defined in cwrs.c. From here on, the value of itheta MUST be treated in a bit-exact manner since 
726 both the encoder and decoder rely on it to infer the bit allocation.
727 </t>
728 <t>
729 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. The number of bits allocated to coding m is obtained by:
730 </t>
731
732 <t>
733 <list>
734 <t>imid = bitexact_cos(itheta);</t>
735 <t>iside = bitexact_cos(16384-itheta);</t>
736 <t>delta = (N-1)*(log2_frac(iside,6)-log2_frac(imid,6))>>2;</t>
737 <t>qalloc = log2_frac((1&lt;&lt;qb)+1,4);</t>
738 <t>mbits = (b-qalloc/2-delta)/2;</t>
739 </list>
740 </t>
741
742 <t>where bitexact_cos() is a fixed-point cosine approximation that MUST be bit-exact with the reference implementation
743 in mathops.h. The spectral folding operation is performed independently for the mid and side vectors.</t>
744 </section>
745
746
747 <section anchor="synthesis" title="Synthesis">
748 <t>
749 After all the quantization is completed, the quantized energy is used along with the 
750 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 buffer</spanx> so it can be used for pitch prediction. 
751 The encoder MAY omit this step of the processing if it knows that it will not be using
752 the pitch predictor for the next few frames. If the de-emphasis filter (<xref target="inverse-mdct"></xref>) is applied to this resynthesized
753 signal, then the output will be the same (within numerical precision) as the decoder's output. 
754 </t>
755 </section>
756
757 <section anchor="vbr" title="Variable Bitrate (VBR)">
758 <t>
759 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.
760 </t>
761 </section>
762
763 </section>
764
765 </section>
766
767 <section title="Codec Decoder">
768 <t>
769 Opus decoder block diagram.
770 </t>
771
772 <section anchor="range-decoder" title="Range Decoder">
773 <t>
774 The range decoder extracts the symbols and integers encoded using the range encoder in
775 <xref target="range-encoder"></xref>. The range decoder maintains an internal
776 state vector composed of the two-tuple (dif,rng), representing the
777 difference between the high end of the current range and the actual
778 coded value, and the size of the current range, respectively. Both
779 dif and rng are 32-bit unsigned integer values. rng is initialized to
780 2^7. dif is initialized to rng minus the top 7 bits of the first
781 input octet. Then the range is immediately normalized, using the
782 procedure described in the following section.
783 </t>
784
785 <section anchor="decoding-symbols" title="Decoding Symbols">
786 <t>
787    Decoding symbols is a two-step process. The first step determines
788    a value fs that lies within the range of some symbol in the current
789    context. The second step updates the range decoder state with the
790    three-tuple (fl,fh,ft) corresponding to that symbol, as defined in
791    <xref target="encoding-symbols"></xref>.
792 </t>
793 <t>
794    The first step is implemented by ec_decode() 
795    (rangedec.c), 
796    and computes fs = ft-min((dif-1)/(rng/ft)+1,ft), where ft is
797    the sum of the frequency counts in the current context, as described
798    in <xref target="encoding-symbols"></xref>. The divisions here are exact integer division. 
799 </t>
800 <t>
801    In the reference implementation, a special version of ec_decode()
802    called ec_decode_bin() (rangeenc.c) is defined using
803    the parameter ftb instead of ft. It is mathematically equivalent to
804    calling ec_decode() with ft = (1&lt;&lt;ftb), but avoids one of the
805    divisions.
806 </t>
807 <t>
808    The decoder then identifies the symbol in the current context
809    corresponding to fs; i.e., the one whose three-tuple (fl,fh,ft)
810    satisfies fl &lt;= fs &lt; fh. This tuple is used to update the decoder
811    state according to dif = dif - (rng/ft)*(ft-fh), and if fl is greater
812    than zero, rng = (rng/ft)*(fh-fl), or otherwise rng = rng - (rng/ft)*(ft-fh). After this update, the range is normalized.
813 </t>
814 <t>
815    To normalize the range, the following process is repeated until
816    rng > 2^23. First, rng is set to (rng&lt;8)&amp;0xFFFFFFFF. Then the next
817    8 bits of input are read into sym, using the remaining bit from the
818    previous input octet as the high bit of sym, and the top 7 bits of the
819    next octet for the remaining bits of sym. If no more input octets
820    remain, zero bits are used instead. Then, dif is set to
821    (dif&lt;&lt;8)-sym&amp;0xFFFFFFFF (i.e., using wrap-around if the subtraction
822    overflows a 32-bit register). Finally, if dif is larger than 2^31,
823    dif is then set to dif - 2^31. This process is carried out by
824    ec_dec_normalize() (rangedec.c).
825 </t>
826 </section>
827
828 <section anchor="decoding-ints" title="Decoding Uniformly Distributed Integers">
829 <t>
830    Functions ec_dec_uint() or ec_dec_bits() are based on ec_decode() and
831    decode one of N equiprobable symbols, each with a frequency of 1,
832    where N may be as large as 2^32-1. Because ec_decode() is limited to
833    a total frequency of 2^16-1, this is done by decoding a series of
834    symbols in smaller contexts.
835 </t>
836 <t>
837    ec_dec_bits() (entdec.c) is defined, like
838    ec_decode_bin(), to take a single parameter ftb, with ftb &lt; 32.
839    and ftb &lt; 32, and produces an ftb-bit decoded integer value, t,
840    initialized to zero. While ftb is greater than 8, it decodes the next
841    8 most significant bits of the integer, s = ec_decode_bin(8), updates
842    the decoder state with the 3-tuple (s,s+1,256), adds those bits to
843    the current value of t, t = t&lt;&lt;8 | s, and subtracts 8 from ftb. Then
844    it decodes the remaining bits of the integer, s = ec_decode_bin(ftb),
845    updates the decoder state with the 3 tuple (s,s+1,1&lt;&lt;ftb), and adds
846    those bits to the final values of t, t = t&lt;&lt;ftb | s.
847 </t>
848 <t>
849    ec_dec_uint() (entdec.c) takes a single parameter,
850    ft, which is not necessarily a power of two, and returns an integer,
851    t, with a value between 0 and ft-1, inclusive, which is initialized to zero. Let
852    ftb be the location of the highest 1 bit in the two's-complement
853    representation of (ft-1), or -1 if no bits are set. If ftb>8, then
854    the top 8 bits of t are decoded using t = ec_decode((ft-1>>ftb-8)+1),
855    the decoder state is updated with the three-tuple
856    (s,s+1,(ft-1>>ftb-8)+1), and the remaining bits are decoded with
857    t = t&lt;&lt;ftb-8|ec_dec_bits(ftb-8). If, at this point, t >= ft, then
858    the current frame is corrupt, and decoding should stop. If the
859    original value of ftb was not greater than 8, then t is decoded with
860    t = ec_decode(ft), and the decoder state is updated with the
861    three-tuple (t,t+1,ft).
862 </t>
863 </section>
864
865 <section anchor="decoder-tell" title="Current Bit Usage">
866 <t>
867    The bit allocation routines in CELT need to be able to determine a
868    conservative upper bound on the number of bits that have been used
869    to decode from the current frame thus far. This drives allocation
870    decisions which must match those made in the encoder. This is
871    computed in the reference implementation to fractional bit precision
872    by the function ec_dec_tell() (rangedec.c). Like all
873    operations in the range decoder, it must be implemented in a
874    bit-exact manner, and must produce exactly the same value returned by
875    ec_enc_tell() after encoding the same symbols.
876 </t>
877 </section>
878
879 </section>
880
881 <section title="SILK Decoder">
882 <t>
883 Copy from SILK draft.
884 </t>
885 </section>
886
887 <section title="CELT Decoder">
888 <t>
889 Insert decoder figure.
890 </t>
891
892 <t>
893 The decoder extracts information from the range-coded bit-stream in the same order
894 as it was encoded by the encoder. In some circumstances, it is 
895 possible for a decoded value to be out of range due to a very small amount of redundancy
896 in the encoding of large integers by the range coder.
897 In that case, the decoder should assume there has been an error in the coding, 
898 decoding, or transmission and SHOULD take measures to conceal the error and/or report
899 to the application that a problem has occurred.
900 </t>
901
902 <section anchor="energy-decoding" title="Energy Envelope Decoding">
903 <t>
904 The energy of each band is extracted from the bit-stream in two steps according
905 to the same coarse-fine strategy used in the encoder. First, the coarse energy is
906 decoded in unquant_coarse_energy() (quant_bands.c)
907 based on the probability of the Laplace model used by the encoder.
908 </t>
909
910 <t>
911 After the coarse energy is decoded, the same allocation function as used in the
912 encoder is called. This determines the number of
913 bits to decode for the fine energy quantization. The decoding of the fine energy bits
914 is performed by unquant_fine_energy() (quant_bands.c).
915 Finally, like the encoder, the remaining bits in the stream (that would otherwise go unused)
916 are decoded using unquant_energy_finalise() (quant_bands.c).
917 </t>
918 </section>
919
920 <section anchor="pitch-decoding" title="Pitch prediction decoding">
921 <t>
922 If the pitch bit is set, then the pitch period is extracted from the bit-stream. The pitch
923 gain bits are extracted within the PVQ decoding as encoded by the encoder. When the folding
924 bit is set, the folding prediction is computed in exactly the same way as the encoder, 
925 with the same gain, by the function intra_fold() (vq.c).
926 </t>
927
928 </section>
929
930 <section anchor="PVQ-decoder" title="Spherical VQ Decoder">
931 <t>
932 In order to correctly decode the PVQ codewords, the decoder must perform exactly the same
933 bits to pulses conversion as the encoder.
934 </t>
935
936 <section anchor="cwrs-decoder" title="Index Decoding">
937 <t>
938 The decoding of the codeword from the index is performed as specified in 
939 <xref target="PVQ"></xref>, as implemented in function
940 decode_pulses() (cwrs.c).
941 </t>
942 </section>
943
944 <section anchor="normalised-decoding" title="Normalised Vector Decoding">
945 <t>
946 The spherical codebook is decoded by alg_unquant() (vq.c).
947 The index of the PVQ entry is obtained from the range coder and converted to 
948 a pulse vector by decode_pulses() (cwrs.c).
949 </t>
950
951 <t>The decoded normalized vector for each band is equal to</t>
952 <t>X' = y/||y||,</t>
953
954 <t>
955 This operation is implemented in mix_pitch_and_residual() (vq.c), 
956 which is the same function as used in the encoder.
957 </t>
958 </section>
959
960
961 </section>
962
963 <section anchor="denormalization" title="Denormalization">
964 <t>
965 Just like each band was normalized in the encoder, the last step of the decoder before
966 the inverse MDCT is to denormalize the bands. Each decoded normalized band is
967 multiplied by the square root of the decoded energy. This is done by denormalise_bands()
968 (bands.c).
969 </t>
970 </section>
971
972 <section anchor="inverse-mdct" title="Inverse MDCT">
973 <t>The inverse MDCT implementation has no special characteristics. The
974 input is N frequency-domain samples and the output is 2*N time-domain 
975 samples, while scaling by 1/2. The output is windowed using the same window 
976 as the encoder. The IMDCT and windowing are performed by mdct_backward
977 (mdct.c). If a time-domain pre-emphasis 
978 window was applied in the encoder, the (inverse) time-domain de-emphasis window
979 is applied on the IMDCT result. After the overlap-add process, 
980 the signal is de-emphasized using the inverse of the pre-emphasis filter 
981 used in the encoder: 1/A(z)=1/(1-alpha_p*z^-1).
982 </t>
983
984 </section>
985
986 <section anchor="Packet Loss Concealment" title="Packet Loss Concealment (PLC)">
987 <t>
988 Packet loss concealment (PLC) is an optional decoder-side feature which 
989 SHOULD be included when transmitting over an unreliable channel. Because 
990 PLC is not part of the bit-stream, there are several possible ways to 
991 implement PLC with different complexity/quality trade-offs. The PLC in
992 the reference implementation finds a periodicity in the decoded
993 signal and repeats the windowed waveform using the pitch offset. The windowed
994 waveform is overlapped in such a way as to preserve the time-domain aliasing
995 cancellation with the previous frame and the next frame. This is implemented 
996 in celt_decode_lost() (mdct.c).
997 </t>
998 </section>
999
1000 </section>
1001
1002 </section>
1003
1004 <section anchor="security" title="Security Considerations">
1005
1006 <t>
1007 The codec needs to take appropriate security considerations 
1008 into account, as outlined in <xref target="DOS"/> and <xref target="SECGUIDE"/>.
1009 It is extremely important for the decoder to be robust against malicious
1010 payloads. Malicious payloads must not cause the decoder to overrun its
1011 allocated memory or to take much more resources to decode. Although problems
1012 in encoders are typically rarer, the same applies to the encoder. Malicious
1013 audio stream must not cause the encoder to misbehave because this would
1014 allow an attacker to attack transcoding gateways.
1015 </t>
1016 <t>
1017 In its current version, the Opus codec likely does NOT meet these
1018 security considerations, so it should be used with caution.
1019 </t>
1020 </section> 
1021
1022
1023 <section title="IANA Considerations ">
1024 <t>
1025 This document has no actions for IANA.
1026 </t>
1027 </section>
1028
1029 <section anchor="Acknowledgments" title="Acknowledgments">
1030 <t>
1031 Thanks to all other developers, including Raymond Chen, Soeren Skak Jensen, Gregory Maxwell, 
1032 Christopher Montgomery, Karsten Vandborg Soerensen, and Timothy Terriberry.
1033 </t>
1034 </section> 
1035
1036 </middle>
1037
1038 <back>
1039
1040 <references title="Informative References">
1041
1042 <reference anchor='SILK'>
1043 <front>
1044 <title>SILK Speech Codec</title>
1045 <author initials='K.' surname='Vos' fullname='K. Vos'>
1046 <organization /></author>
1047 <author initials='S.' surname='Jensen' fullname='S. Jensen'>
1048 <organization /></author>
1049 <author initials='K.' surname='Soerensen' fullname='K. Soerensen'>
1050 <organization /></author>
1051 <date year='2010' month='March' />
1052 <abstract>
1053 <t></t>
1054 </abstract></front>
1055 <seriesInfo name='Internet-Draft' value='draft-vos-silk-01' />
1056 <format type='TXT' target='http://tools.ietf.org/html/draft-vos-silk-01' />
1057 </reference>
1058
1059 <reference anchor='CELT'>
1060 <front>
1061 <title>Constrained-Energy Lapped Transform (CELT) Codec</title>
1062 <author initials='J-M.' surname='Valin' fullname='J-M. Valin'>
1063 <organization /></author>
1064 <author initials='T.' surname='Terriberry' fullname='T. Terriberry'>
1065 <organization /></author>
1066 <author initials='G.' surname='Maxwell' fullname='G. Maxwell'>
1067 <organization /></author>
1068 <author initials='C.' surname='Montgomery' fullname='C. Montgomery'>
1069 <organization /></author>
1070 <date year='2010' month='July' />
1071 <abstract>
1072 <t></t>
1073 </abstract></front>
1074 <seriesInfo name='Internet-Draft' value='draft-valin-celt-codec-02' />
1075 <format type='TXT' target='http://tools.ietf.org/html/draft-valin-celt-codec-02' />
1076 </reference>
1077
1078 <reference anchor='DOS'>
1079 <front>
1080 <title>Internet Denial-of-Service Considerations</title>
1081 <author initials='M.' surname='Handley' fullname='M. Handley'>
1082 <organization /></author>
1083 <author initials='E.' surname='Rescorla' fullname='E. Rescorla'>
1084 <organization /></author>
1085 <author>
1086 <organization>IAB</organization></author>
1087 <date year='2006' month='December' />
1088 <abstract>
1089 <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>
1090 <seriesInfo name='RFC' value='4732' />
1091 <format type='TXT' octets='91844' target='ftp://ftp.isi.edu/in-notes/rfc4732.txt' />
1092 </reference>
1093
1094 <reference anchor='SECGUIDE'>
1095 <front>
1096 <title>Guidelines for Writing RFC Text on Security Considerations</title>
1097 <author initials='E.' surname='Rescorla' fullname='E. Rescorla'>
1098 <organization /></author>
1099 <author initials='B.' surname='Korver' fullname='B. Korver'>
1100 <organization /></author>
1101 <date year='2003' month='July' />
1102 <abstract>
1103 <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>
1104
1105 <seriesInfo name='BCP' value='72' />
1106 <seriesInfo name='RFC' value='3552' />
1107 <format type='TXT' octets='110393' target='ftp://ftp.isi.edu/in-notes/rfc3552.txt' />
1108 </reference>
1109
1110 <reference anchor="range-coding">
1111 <front>
1112 <title>Range encoding: An algorithm for removing redundancy from a digitised message</title>
1113 <author initials="G." surname="Nigel" fullname=""><organization/></author>
1114 <author initials="N." surname="Martin" fullname=""><organization/></author>
1115 <date year="1979" />
1116 </front>
1117 <seriesInfo name="Proc. Institution of Electronic and Radio Engineers International Conference on Video and Data Recording" value="" />
1118 </reference> 
1119
1120 <reference anchor="coding-thesis">
1121 <front>
1122 <title>Source coding algorithms for fast data compression</title>
1123 <author initials="R." surname="Pasco" fullname=""><organization/></author>
1124 <date month="May" year="1976" />
1125 </front>
1126 <seriesInfo name="Ph.D. thesis" value="Dept. of Electrical Engineering, Stanford University" />
1127 </reference>
1128
1129 <reference anchor="PVQ">
1130 <front>
1131 <title>A Pyramid Vector Quantizer</title>
1132 <author initials="T." surname="Fischer" fullname=""><organization/></author>
1133 <date month="July" year="1986" />
1134 </front>
1135 <seriesInfo name="IEEE Trans. on Information Theory, Vol. 32" value="pp. 568-583" />
1136 </reference> 
1137
1138 </references> 
1139
1140 <section anchor="ref-implementation" title="Reference Implementation">
1141
1142 <t>This appendix contains the complete source code for the
1143 reference implementation of the Opus codec written in C. This
1144 implementation can be compiled for 
1145 either floating-point or fixed-point architectures.
1146 </t>
1147
1148 <t>The implementation can be compiled with either a C89 or a C99
1149 compiler. It is reasonably optimized for most platforms such that
1150 only architecture-specific optimizations are likely to be useful.
1151 The FFT used is a slightly modified version of the KISS-FFT package,
1152 but it is easy to substitute any other FFT library.
1153 </t>
1154
1155 <section title="Extracting the source">
1156 <t>
1157 The complete source code can be extracted from this draft, by running the
1158 following command line:
1159
1160 <list style="symbols">
1161 <t><![CDATA[
1162 cat draft-ietf-codec-opus.txt | grep '^   ###' | sed 's/   ###//' | base64 -d > opus_source.tar.gz
1163 ]]></t>
1164 <t>
1165 tar xzvf opus_source.tar.gz
1166 </t>
1167 </list>
1168
1169 </t>
1170 </section>
1171
1172 <section title="Base64-encoded source code">
1173 <t>
1174 <?rfc include="opus_source.base64"?>
1175 </t>
1176 </section>
1177
1178 </section>
1179
1180 </back>
1181
1182 </rfc>