More spec additions, and some minor clean-up.
[opus.git] / doc / draft-ietf-codec-opus.xml
1 <?xml version="1.0" encoding="utf-8"?>
2 <!DOCTYPE rfc SYSTEM 'rfc2629.dtd'>
3 <?rfc toc="yes" symrefs="yes" ?>
4
5 <rfc ipr="trust200902" category="std" docName="draft-ietf-codec-opus-06">
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>jmvalin@jmvalin.ca</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 <author initials="T." surname="Terriberry" fullname="Timothy Terriberry">
42 <organization>Mozilla Corporation</organization>
43 <address>
44 <postal>
45 <street>650 Castro Street</street>
46 <city>Mountain View</city>
47 <region>CA</region>
48 <code>94041</code>
49 <country>USA</country>
50 </postal>
51 <phone>+1 650 903-0800</phone>
52 <email>tterriberry@mozilla.com</email>
53 </address>
54 </author>
55
56 <date day="7" month="July" year="2011" />
57
58 <area>General</area>
59
60 <workgroup></workgroup>
61
62 <abstract>
63 <t>
64 This document defines the Opus codec, designed for interactive speech and audio
65  transmission over the Internet.
66 </t>
67 </abstract>
68 </front>
69
70 <middle>
71
72 <section anchor="introduction" title="Introduction">
73 <t>
74 The Opus codec is a real-time interactive audio codec composed of a linear
75  prediction (LP)-based layer and a Modified Discrete Cosine Transform
76  (MDCT)-based layer.
77 The main idea behind using two layers is that in speech, linear prediction
78  techniques (such as CELP) code low frequencies more efficiently than transform
79  (e.g., MDCT) domain techniques, while the situation is reversed for music and
80  higher speech frequencies.
81 Thus a codec with both layers available can operate over a wider range than
82  either one alone and, by combining them, achieve better quality than either
83  one individually.
84 </t>
85
86 <t>
87 The primary normative part of this specification is provided by the source code
88  in <xref target="ref-implementation"></xref>.
89 In general, only the decoder portion of this software is normative, though a
90  significant amount of code is shared by both the encoder and decoder.
91 <!--TODO: Forward reference conformance test-->
92 The decoder contains significant amounts of integer and fixed-point arithmetic
93  which must be performed exactly, including all rounding considerations, so any
94  useful specification must make extensive use of domain-specific symbolic
95  language to adequately define these operations.
96 Additionally, any
97 conflict between the symbolic representation and the included reference
98 implementation must be resolved. For the practical reasons of compatibility and
99 testability it would be advantageous to give the reference implementation
100 priority in any disagreement. The C language is also one of the most
101 widely understood human-readable symbolic representations for machine
102 behavior.
103 For these reasons this RFC uses the reference implementation as the sole
104  symbolic representation of the codec.
105 </t>
106
107 <!--TODO: C is not unambiguous; many parts are implementation-defined-->
108 <t>While the symbolic representation is unambiguous and complete it is not
109 always the easiest way to understand the codec's operation. For this reason
110 this document also describes significant parts of the codec in English and
111 takes the opportunity to explain the rationale behind many of the more
112 surprising elements of the design. These descriptions are intended to be
113 accurate and informative, but the limitations of common English sometimes
114 result in ambiguity, so it is expected that the reader will always read
115 them alongside the symbolic representation. Numerous references to the
116 implementation are provided for this purpose. The descriptions sometimes
117 differ from the reference in ordering or through mathematical simplification
118 wherever such deviation makes an explanation easier to understand.
119 For example, the right shift and left shift operations in the reference
120 implementation are often described using division and multiplication in the text.
121 In general, the text is focused on the "what" and "why" while the symbolic
122 representation most clearly provides the "how".
123 </t>
124
125 <section anchor="notation" title="Notation and Conventions">
126 <t>
127 The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD",
128  "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be
129  interpreted as described in RFC 2119.
130 </t>
131 <t>
132 Even when using floating-point, various operations in the codec require
133  bit-exact fixed-point behavior.
134 The notation "Q<spanx style="emph">n</spanx>", where
135  <spanx style="emph">n</spanx> is an integer, denotes the number of binary
136  digits to the right of the decimal point in a fixed-point number.
137 For example, a signed Q14 value in a 16-bit word can represent values from
138  -2.0 to 1.99993896484375, inclusive.
139 This notation is for informational purposes only.
140 Arithmetic, when described, always operates on the underlying integer.
141 E.g., the text will explicitly indicate any shifts required after a
142  multiplication.
143 </t>
144 <t>
145 Expressions, where included in the text, follow C operator rules and
146  precedence, with the exception that syntax like "2**n" is used to indicate 2
147  raised to the power n.
148 The text also makes use of the following functions:
149 </t>
150
151 <section anchor="min" title="min(x,y)">
152 <t>
153 The smallest of two values x and y.
154 </t>
155 </section>
156
157 <section anchor="max" title="max(x,y)">
158 <t>
159 The largest of two values x and y.
160 </t>
161 </section>
162
163 <section anchor="clamp" title="clamp(lo,x,hi)">
164 <figure align="center">
165 <artwork align="center"><![CDATA[
166 clamp(lo,x,hi) = max(lo,min(x,hi))
167 ]]></artwork>
168 </figure>
169 <t>
170 With this definition, if lo&gt;hi, the lower bound is the one that is enforced.
171 </t>
172 </section>
173
174 <section anchor="sign" title="sign(x)">
175 <t>
176 The sign of x, i.e.,
177 <figure align="center">
178 <artwork align="center"><![CDATA[
179           ( -1,  x < 0 ,
180 sign(x) = <  0,  x == 0 ,
181           (  1,  x > 0 .
182 ]]></artwork>
183 </figure>
184 </t>
185 </section>
186
187 <section anchor="log2" title="log2(f)">
188 <t>
189 The base-two logarithm of f.
190 </t>
191 </section>
192
193 <section anchor="ilog" title="ilog(n)">
194 <t>
195 The minimum number of bits required to store a positive integer n in two's
196  complement notation, or 0 for a non-positive integer n.
197 <figure align="center">
198 <artwork align="center"><![CDATA[
199           ( 0,                 n <= 0,
200 ilog(n) = <
201           ( floor(log2(n))+1,  n > 0
202 ]]></artwork>
203 </figure>
204 Examples:
205 <list style="symbols">
206 <t>ilog(-1) = 0</t>
207 <t>ilog(0) = 0</t>
208 <t>ilog(1) = 1</t>
209 <t>ilog(2) = 2</t>
210 <t>ilog(3) = 2</t>
211 <t>ilog(4) = 3</t>
212 <t>ilog(7) = 3</t>
213 </list>
214 </t>
215 </section>
216
217 </section>
218
219 </section>
220
221 <section anchor="overview" title="Opus Codec Overview">
222
223 <t>
224 The Opus codec scales from 6&nbsp;kb/s narrowband mono speech to 510&nbsp;kb/s
225  fullband stereo music, with algorithmic delays ranging from 5&nbsp;ms to
226  65.2&nbsp;ms.
227 At any given time, either the LP layer, the MDCT layer, or both, may be active.
228 It can seamlessly switch between all of its various operating modes, giving it
229  a great deal of flexibility to adapt to varying content and network
230  conditions without renegotiating the current session.
231 Internally, the codec always operates at a 48&nbsp;kHz sampling rate, though it
232  allows input and output of various bandwidths, defined as follows:
233 </t>
234 <texttable>
235 <ttcol>Abbreviation</ttcol>
236 <ttcol align="right">Audio Bandwidth</ttcol>
237 <ttcol align="right">Sampling Rate (Effective)</ttcol>
238 <c>NB (narrowband)</c>       <c>4&nbsp;kHz</c>  <c>8&nbsp;kHz</c>
239 <c>MB (medium-band)</c>      <c>6&nbsp;kHz</c> <c>12&nbsp;kHz</c>
240 <c>WB (wideband)</c>         <c>8&nbsp;kHz</c> <c>16&nbsp;kHz</c>
241 <c>SWB (super-wideband)</c> <c>12&nbsp;kHz</c> <c>24&nbsp;kHz</c>
242 <c>FB (fullband)</c>        <c>20&nbsp;kHz</c> <c>48&nbsp;kHz</c>
243 </texttable>
244 <t>
245 These can be chosen independently on the encoder and decoder side, e.g., a
246  fullband signal can be decoded as wideband, or vice versa.
247 This approach ensures a sender and receiver can always interoperate, regardless
248  of the capabilities of their actual audio hardware.
249 </t>
250
251 <t>
252 The LP layer is based on the
253  <eref target='http://developer.skype.com/silk'>SILK</eref> codec
254  <xref target="SILK"></xref>.
255 It supports NB, MB, or WB audio and frame sizes from 10&nbsp;ms to 60&nbsp;ms,
256  and requires an additional 5.2&nbsp;ms look-ahead for noise shaping estimation
257  (5&nbsp;ms) and internal resampling (0.2&nbsp;ms).
258 Like Vorbis and many other modern codecs, SILK is inherently designed for
259  variable-bitrate (VBR) coding, though an encoder can with sufficient effort
260  produce constant-bitrate (CBR) or near-CBR streams.
261 </t>
262
263 <t>
264 The MDCT layer is based on the
265  <eref target='http://www.celt-codec.org/'>CELT</eref>  codec
266  <xref target="CELT"></xref>.
267 It supports sampling NB, WB, SWB, or FB audio and frame sizes from 2.5&nbsp;ms
268  to 20&nbsp;ms, and requires an additional 2.5&nbsp;ms look-ahead due to the
269  overlapping MDCT windows.
270 The CELT codec is inherently designed for CBR coding, but unlike many CBR
271  codecs it is not limited to a set of predetermined rates.
272 It internally allocates bits to exactly fill any given target budget, and an
273  encoder can produce a VBR stream by varying the target on a per-frame basis.
274 The MDCT layer is not used for speech when the audio bandwidth is WB or less,
275  as it is not useful there.
276 On the other hand, non-speech signals are not always adequately coded using
277  linear prediction, so for music only the MDCT layer should be used.
278 </t>
279
280 <t>
281 A hybrid mode allows the use of both layers simultaneously with a frame size of
282  10 or 20&nbsp;ms and a SWB or FB audio bandwidth.
283 Each frame is split into a low frequency signal and a high frequency signal,
284  with a cutoff of 8&nbsp;kHz.
285 The LP layer then codes the low frequency signal, followed by the MDCT layer
286  coding the high frequency signal.
287 In the MDCT layer, all bands below 8&nbsp;kHz are discarded, so there is no
288  coding redundancy between the two layers.
289 </t>
290
291 <t>
292 At the decoder, the two decoder outputs are simply added together.
293 To compensate for the different look-aheads required by each layer, the CELT
294  encoder input is delayed by an additional 2.7&nbsp;ms.
295 This ensures that low frequencies and high frequencies arrive at the same time.
296 This extra delay MAY be reduced by an encoder by using less lookahead for noise
297  shaping or using a simpler resampler in the LP layer, but this will reduce
298  quality.
299 However, the base 2.5&nbsp;ms look-ahead in the CELT layer cannot be reduced in
300  the encoder because it is needed for the MDCT overlap, whose size is fixed by
301  the decoder.
302 </t>
303
304 <t>
305 Both layers use the same entropy coder, avoiding any waste from "padding bits"
306  between them.
307 The hybrid approach makes it easy to support both CBR and VBR coding.
308 Although the LP layer is VBR, the bit allocation of the MDCT layer can produce
309  a final stream that is CBR by using all the bits left unused by the LP layer.
310 </t>
311
312 </section>
313
314 <section anchor="modes" title="Codec Modes">
315 <t>
316 As described, the two layers can be combined in three possible operating modes:
317 <list style="numbers">
318 <t>A LP-only mode for use in low bitrate connections with an audio bandwidth of
319  WB or less,</t>
320 <t>A hybrid (LP+MDCT) mode for SWB or FB speech at medium bitrates, and</t>
321 <t>An MDCT-only mode for very low delay speech transmission as well as music
322  transmission.</t>
323 </list>
324 A single packet may contain multiple audio frames, however they must share a
325  common set of parameters, including the operating mode, audio bandwidth, frame
326  size, and channel count.
327 A single-byte table-of-contents (TOC) header signals which of the various modes
328  and configurations a given packet uses.
329 It is composed of a frame count code, "c", a stereo flag, "s", and a
330  configuration number, "config", arranged as illustrated in
331  <xref target="toc_byte"/>.
332 A description of each of these fields follows.
333 </t>
334
335 <figure anchor="toc_byte" title="The TOC byte">
336 <artwork align="center"><![CDATA[
337  0
338  0 1 2 3 4 5 6 7
339 +-+-+-+-+-+-+-+-+
340 | c |s| config  |
341 +-+-+-+-+-+-+-+-+
342 ]]></artwork>
343 </figure>
344
345 <t>
346 The top five bits of the TOC byte, labeled "config", encode one of 32 possible
347  configurations of operating mode, audio bandwidth, and frame size.
348 <xref target="config_bits"/> lists the parameters for each configuration.
349 </t>
350 <texttable anchor="config_bits" title="TOC Byte Configuration Parameters">
351 <ttcol>Configuration Number(s)</ttcol>
352 <ttcol>Mode</ttcol>
353 <ttcol>Bandwidth</ttcol>
354 <ttcol>Frame Size(s)</ttcol>
355 <c>0...3</c>   <c>LP-only</c>   <c>NB</c>  <c>10, 20, 40, 60&nbsp;ms</c>
356 <c>4...7</c>   <c>LP-only</c>   <c>MB</c>  <c>10, 20, 40, 60&nbsp;ms</c>
357 <c>8...11</c>  <c>LP-only</c>   <c>WB</c>  <c>10, 20, 40, 60&nbsp;ms</c>
358 <c>12...13</c> <c>Hybrid</c>    <c>SWB</c> <c>10, 20&nbsp;ms</c>
359 <c>14...15</c> <c>Hybrid</c>    <c>FB</c>  <c>10, 20&nbsp;ms</c>
360 <c>16...19</c> <c>MDCT-only</c> <c>NB</c>  <c>2.5, 5, 10, 20&nbsp;ms</c>
361 <c>20...23</c> <c>MDCT-only</c> <c>WB</c>  <c>2.5, 5, 10, 20&nbsp;ms</c>
362 <c>24...27</c> <c>MDCT-only</c> <c>SWB</c> <c>2.5, 5, 10, 20&nbsp;ms</c>
363 <c>28...31</c> <c>MDCT-only</c> <c>FB</c>  <c>2.5, 5, 10, 20&nbsp;ms</c>
364 </texttable>
365
366 <t>
367 One additional bit, labeled "s", is used to signal mono vs. stereo, with 0
368  indicating mono and 1 indicating stereo.
369 The remaining two bits, labeled "c", code the number of frames per packet
370  (codes 0 to 3) as follows:
371 <list style="symbols">
372 <t>0:    1 frame in the packet</t>
373 <t>1:    2 frames in the packet, each with equal compressed size</t>
374 <t>2:    2 frames in the packet, with different compressed sizes</t>
375 <t>3:    an arbitrary number of frames in the packet</t>
376 </list>
377 </t>
378
379 <t>
380 A well-formed Opus packet MUST contain at least one byte with the TOC
381  information, though the frame(s) within a packet MAY be zero bytes long.
382 It must also obey various additional rules indicated by "MUST", "MUST NOT",
383  etc., in this section.
384 A receiver MUST NOT process packets which violate these rules as normal Opus
385  packets.
386 They are reserved for future applications, such as in-band headers (containing
387  metadata, etc.) or multichannel support.
388 </t>
389
390 <t>
391 When a packet contains multiple VBR frames, the compressed length of one or
392  more of these frames is indicated with a one or two byte sequence, with the
393  meaning of the first byte as follows:
394 <list style="symbols">
395 <t>0:          No frame (DTX or lost packet)</t>
396 <!--TODO: Would be nice to be clearer about the distinction between "frame
397  size" (in samples or ms) and "the compressed size of the frame" (in bytes).
398 "the compressed length of the frame" is maybe a little better, but not when we
399  jump back and forth to talking about sizes.-->
400 <t>1...251:    Size of the frame in bytes</t>
401 <t>252...255:  A second byte is needed. The total size is (size[1]*4)+size[0]</t>
402 </list>
403 </t>
404
405 <t>
406 The maximum representable size is 255*4+255=1275&nbsp;bytes.
407 For 20&nbsp;ms frames, this represents a bitrate of 510&nbsp;kb/s, which is
408  approximately the highest useful rate for lossily compressed fullband stereo
409  music.
410 Beyond this point, lossless codecs are more appropriate.
411 It is also roughly the maximum useful rate of the MDCT layer, as shortly
412  thereafter quality no longer improves with additional bits due to limitations
413  on the codebook sizes.
414 </t>
415
416 <t>
417 No length is transmitted for the last frame in a VBR packet, or any of the
418  frames in a CBR packet, as it can be inferred from the total size of the
419  packet and the size of all other data in the packet.
420 However, it MUST NOT exceed 1275&nbsp;bytes, to allow for repacketization by
421  gateways, conference bridges, or other software.
422 </t>
423
424 <t>
425 For code 0 packets, the TOC byte is immediately followed by N-1&nbsp;bytes of
426  compressed data for a single frame (where N is the size of the packet),
427  as illustrated in <xref target="code0_packet"/>.
428 </t>
429 <figure anchor="code0_packet" title="A Code 0 Packet" align="center">
430 <artwork align="center"><![CDATA[
431  0                   1                   2                   3
432  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
433 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
434 |0|0|s| config  |                                               |
435 +-+-+-+-+-+-+-+-+                                               |
436 |                    Compressed frame 1 (N-1 bytes)...          :
437 :                                                               |
438 |                                                               |
439 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
440 ]]></artwork>
441 </figure>
442
443 <t>
444 For code 1 packets, the TOC byte is immediately followed by the
445  (N-1)/2&nbsp;bytes of compressed data for the first frame, followed by
446  (N-1)/2&nbsp;bytes of compressed data for the second frame, as illustrated in
447  <xref target="code1_packet"/>.
448 The number of payload bytes available for compressed data, N-1, MUST be even
449  for all code 1 packets.
450 </t>
451 <figure anchor="code1_packet" title="A Code 1 Packet" align="center">
452 <artwork align="center"><![CDATA[
453  0                   1                   2                   3
454  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
455 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
456 |1|0|s| config  |                                               |
457 +-+-+-+-+-+-+-+-+                                               :
458 |             Compressed frame 1 ((N-1)/2 bytes)...             |
459 :                               +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
460 |                               |                               |
461 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+                               :
462 |             Compressed frame 2 ((N-1)/2 bytes)...             |
463 :                                               +-+-+-+-+-+-+-+-+
464 |                                               |
465 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
466 ]]></artwork>
467 </figure>
468
469 <t>
470 For code 2 packets, the TOC byte is followed by a one or two byte sequence
471  indicating the the length of the first frame (marked N1 in the figure below),
472  followed by N1 bytes of compressed data for the first frame.
473 The remaining N-N1-2 or N-N1-3&nbsp;bytes are the compressed data for the
474  second frame.
475 This is illustrated in <xref target="code2_packet"/>.
476 The length of the first frame, N1, MUST be no larger than the size of the
477  payload remaining after decoding that length for all code 2 packets.
478 </t>
479 <figure anchor="code2_packet" title="A Code 2 Packet" align="center">
480 <artwork align="center"><![CDATA[
481  0                   1                   2                   3
482  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
483 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
484 |0|1|s| config  | N1 (1-2 bytes):                               |
485 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+                               :
486 |               Compressed frame 1 (N1 bytes)...                |
487 :                               +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
488 |                               |                               |
489 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+                               |
490 |                     Compressed frame 2...                     :
491 :                                                               |
492 |                                                               |
493 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
494 ]]></artwork>
495 </figure>
496
497 <t>
498 For code 3 packets, the TOC byte is followed by a byte encoding the number of
499  frames in the packet in bits 0 to 5 (marked "M" in the figure below), with bit
500  6 indicating whether or not padding is inserted (marked "p" in the figure
501  below), and bit 7 indicating VBR (marked "v" in the figure below).
502 M MUST NOT be zero, and the audio duration contained within a packet MUST NOT
503  exceed 120&nbsp;ms.
504 This limits the maximum frame count for any frame size to 48 (for 2.5&nbsp;ms
505  frames), with lower limits for longer frame sizes.
506 <xref target="frame_count_byte"/> illustrates the layout of the frame count
507  byte.
508 </t>
509 <figure anchor="frame_count_byte" title="The frame count byte">
510 <artwork align="center"><![CDATA[
511  0
512  0 1 2 3 4 5 6 7
513 +-+-+-+-+-+-+-+-+
514 |     M     |p|v|
515 +-+-+-+-+-+-+-+-+
516 ]]></artwork>
517 </figure>
518 <t>
519 When padding is used, the number of bytes of padding is encoded in the
520  bytes following the frame count byte.
521 Values from 0...254 indicate that 0...254&nbsp;bytes of padding are included,
522  in addition to the byte(s) used to indicate the size of the padding.
523 If the value is 255, then the size of the additional padding is 254&nbsp;bytes,
524  plus the padding value encoded in the next byte.
525 The additional padding bytes appear at the end of the packet, and SHOULD be set
526  to zero by the encoder, however the decoder MUST accept any value for the
527  padding bytes.
528 By using code 255 multiple times, it is possible to create a packet of any
529  specific, desired size.
530 Let P be the total amount of padding, including both the trailing padding bytes
531  themselves and the header bytes used to indicate how many there are.
532 Then P MUST be no more than N-2 for CBR packets, or N-M-1 for VBR packets.
533 </t>
534 <t>
535 In the CBR case, the compressed length of each frame in bytes is equal to the
536  number of remaining bytes in the packet after subtracting the (optional)
537  padding, (N-2-P), divided by M.
538 This number MUST be an integer multiple of M.
539 The compressed data for all M frames then follows, each of size
540  (N-2-P)/M&nbsp;bytes, as illustrated in <xref target="code3cbr_packet"/>.
541 </t>
542
543 <figure anchor="code3cbr_packet" title="A CBR Code 3 Packet" align="center">
544 <artwork align="center"><![CDATA[
545  0                   1                   2                   3
546  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
547 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
548 |1|1|s| config  |     M     |p|0|  Padding length (Optional)    :
549 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
550 |                                                               |
551 :            Compressed frame 1 ((N-2-P)/M bytes)...            :
552 |                                                               |
553 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
554 |                                                               |
555 :            Compressed frame 2 ((N-2-P)/M bytes)...            :
556 |                                                               |
557 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
558 |                                                               |
559 :                              ...                              :
560 |                                                               |
561 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
562 |                                                               |
563 :            Compressed frame M ((N-2-P)/M bytes)...            :
564 |                                                               |
565 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
566 :                     Padding (Optional)...                     |
567 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
568 ]]></artwork>
569 </figure>
570
571 <t>
572 In the VBR case, the (optional) padding length is followed by M-1 frame
573  lengths (indicated by "N1" to "N[M-1]" in the figure below), each encoded in a
574  one or two byte sequence as described above.
575 The packet MUST contain enough data for the M-1 lengths after the (optional)
576  padding, and the sum of these lengths MUST be no larger than the number of
577  bytes remaining in the packet after decoding them.
578 The compressed data for all M frames follows, each frame consisting of the
579  indicated number of bytes, with the final frame consuming any remaining bytes
580  before the final padding, as illustrated in <xref target="code3cbr_packet"/>.
581 The number of header bytes (TOC byte, frame count byte, padding length bytes,
582  and frame length bytes), plus the length of the first M-1 frames themselves,
583  plus the length of the padding MUST be no larger than N, the total size of the
584  packet.
585 </t>
586
587 <figure anchor="code3vbr_packet" title="A VBR Code 3 Packet" align="center">
588 <artwork align="center"><![CDATA[
589  0                   1                   2                   3
590  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
591 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
592 |1|1|s| config  |     M     |p|1| Padding length (Optional)     :
593 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
594 : N1 (1-2 bytes): N2 (1-2 bytes):     ...       :     N[M-1]    |
595 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
596 |                                                               |
597 :               Compressed frame 1 (N1 bytes)...                :
598 |                                                               |
599 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
600 |                                                               |
601 :               Compressed frame 2 (N2 bytes)...                :
602 |                                                               |
603 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
604 |                                                               |
605 :                              ...                              :
606 |                                                               |
607 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
608 |                                                               |
609 :                     Compressed frame M...                     :
610 |                                                               |
611 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
612 :                     Padding (Optional)...                     |
613 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
614 ]]></artwork>
615 </figure>
616
617 <section anchor="examples" title="Examples">
618 <t>
619 Simplest case, one NB mono 20&nbsp;ms SILK frame:
620 </t>
621
622 <figure>
623 <artwork><![CDATA[
624  0                   1                   2                   3
625  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
626 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
627 |0|0|0|    1    |               compressed data...              :
628 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
629 ]]></artwork>
630 </figure>
631
632 <t>
633 Two FB mono 5&nbsp;ms CELT frames of the same compressed size:
634 </t>
635
636 <figure>
637 <artwork><![CDATA[
638  0                   1                   2                   3
639  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
640 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
641 |1|0|0|   29    |               compressed data...              :
642 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
643 ]]></artwork>
644 </figure>
645
646 <t>
647 Two FB mono 20&nbsp;ms hybrid frames of different compressed size:
648 </t>
649
650 <figure>
651 <artwork><![CDATA[
652  0                   1                   2                   3
653  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
654 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
655 |1|1|0|   15    |     2     |0|1|      N1       |               |
656 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+               |
657 |                       compressed data...                      :
658 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
659 ]]></artwork>
660 </figure>
661
662 <t>
663 Four FB stereo 20&nbsp;ms CELT frames of the same compressed size:
664 </t>
665
666 <figure>
667 <artwork><![CDATA[
668  0                   1                   2                   3
669  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
670 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
671 |1|1|1|   31    |     4     |0|0|      compressed data...       :
672 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
673 ]]></artwork>
674 </figure>
675 </section>
676
677
678 </section>
679
680 <section title="Opus Decoder">
681 <t>
682 The Opus decoder consists of two main blocks: the SILK decoder and the CELT decoder.
683 The output of the Opus decode is the sum of the outputs from the SILK and CELT decoders
684 with proper sample rate conversion and delay compensation as illustrated in the
685 block diagram below. At any given time, one or both of the SILK and CELT decoders
686 may be active.
687 </t>
688 <figure>
689 <artwork>
690 <![CDATA[
691                        +-------+    +----------+
692                        | SILK  |    |  sample  |
693                     +->|encoder|--->|   rate   |----+
694 bit-    +-------+   |  |       |    |conversion|    v
695 stream  | Range |---+  +-------+    +----------+  /---\  audio
696 ------->|decoder|                                 | + |------>
697         |       |---+  +-------+    +----------+  \---/
698         +-------+   |  | CELT  |    | Delay    |    ^
699                     +->|decoder|----| compens- |----+
700                        |       |    | ation    |
701                        +-------+    +----------+
702 ]]>
703 </artwork>
704 </figure>
705
706 <section anchor="range-decoder" title="Range Decoder">
707 <t>
708 Opus uses an entropy coder based on <xref target="range-coding"></xref>,
709 which is itself a rediscovery of the FIFO arithmetic code introduced by <xref target="coding-thesis"></xref>.
710 It is very similar to arithmetic encoding, except that encoding is done with
711 digits in any base instead of with bits,
712 so it is faster when using larger bases (i.e., an octet). All of the
713 calculations in the range coder must use bit-exact integer arithmetic.
714 </t>
715 <t>
716 Symbols may also be coded as <spanx style="emph">raw bits</spanx> packed
717  directly into the bitstream, bypassing the range coder.
718 These are packed backwards starting at the end of the frame.
719 This reduces complexity and makes the stream more resilient to bit errors, as
720  corruption in the raw bits will not desynchronize the decoding process, unlike
721  corruption in the input to the range decoder.
722 Raw bits are only used in the CELT layer.
723 </t>
724 <t>
725 Each symbol coded by the range coder is drawn from a finite alphabet and coded
726  in a separate <spanx style="emph">context</spanx>, which describes the size of
727  the alphabet and the relative frequency of each symbol in that alphabet.
728 Opus only uses static contexts.
729 They are not adapted to the statistics of the data as it is coded.
730 </t>
731 <t>
732 The parameters needed to encode or decode a symbol in a given context are
733  represented by a three-tuple (fl,fh,ft), with
734  0 &lt;= fl &lt; fh &lt;= ft &lt;= 65535.
735 The values of this tuple are derived from the probability model for the
736  symbol, represented by traditional <spanx style="emph">frequency counts</spanx>
737  (although, since Opus uses static contexts, these are not updated as symbols
738  are decoded).
739 Let f[i] be the frequency of the <spanx style="emph">i</spanx>th symbol in a
740  context with <spanx style="emph">n</spanx> symbols total.
741 Then the three-tuple corresponding to the <spanx style="emph">k</spanx>th
742  symbol is given by
743 </t>
744 <figure align="center">
745 <artwork align="center"><![CDATA[
746      k-1                             n-1
747      __                              __
748 fl = \  f[i],  fh = fl + f[k],  ft = \  f[i]
749      /_                              /_
750      i=0                             i=0
751 ]]></artwork>
752 </figure>
753 <t>
754 The range decoder extracts the symbols and integers encoded using the range
755  encoder in <xref target="range-encoder"/>.
756 The range decoder maintains an internal state vector composed of the two-tuple
757  (val,rng), representing the difference between the high end of the current
758  range and the actual coded value, minus one, and the size of the current
759  range, respectively.
760 Both val and rng are 32-bit unsigned integer values.
761 The decoder initializes rng to 128 and initializes val to 127 minus the top 7
762  bits of the first input octet.
763 It then immediately normalizes the range using the procedure described in
764  <xref target="range-decoder-renorm"/>.
765 </t>
766
767 <section anchor="decoding-symbols" title="Decoding Symbols">
768 <t>
769 Decoding a symbol is a two-step process.
770 The first step determines a 16-bit unsigned value fs, which lies within the
771  range of some symbol in the current context.
772 The second step updates the range decoder state with the three-tuple (fl,fh,ft)
773  corresponding to that symbol.
774 </t>
775 <t>
776 The first step is implemented by ec_decode() (entdec.c), which computes
777  fs = ft - min(val/(rng/ft)+1, ft).
778 The divisions here are exact integer division.
779 </t>
780 <t>
781 The decoder then identifies the symbol in the current context corresponding to
782  fs; i.e., the one whose three-tuple (fl,fh,ft) satisfies fl &lt;= fs &lt; fh.
783 It uses this tuple to update val according to
784  val = val - (rng/ft)*(ft-fh).
785 If fl is greater than zero, then the decoder updates rng using
786  rng = (rng/ft)*(fh-fl).
787 Otherwise, it updates rng using rng = rng - (rng/ft)*(ft-fh).
788 After these updates, implemented by ec_dec_update() (entdec.c), it normalizes
789  the range using the procedure in the next section, and returns the index of
790  the identified symbol.
791 </t>
792 <t>
793 With this formulation, all the truncation error from using finite precision
794  arithmetic accumulates in symbol 0.
795 This makes the cost of coding a 0 slightly smaller, on average, than the
796  negative log of its estimated probability and makes the cost of coding any
797  other symbol slightly larger.
798 When contexts are designed so that 0 is the most probable symbol, which is
799  often the case, this strategy minimizes the inefficiency introduced by the
800  finite precision.
801 </t>
802
803 <section anchor="range-decoder-renorm" title="Renormalization">
804 <t>
805 To normalize the range, the decoder repeats the following process, implemented
806  by ec_dec_normalize() (entdec.c), until rng > 2**23.
807 If rng is already greater than 2**23, the entire process is skipped.
808 First, it sets rng to (rng&lt;&lt;8).
809 Then it reads the next 8 bits of input into sym, using the remaining bit from
810  the previous input octet as the high bit of sym, and the top 7 bits of the
811  next octet as the remaining bits of sym.
812 If no more input octets remain, it uses zero bits instead.
813 Then, it sets val to (val&lt;&lt;8)+(255-sym)&amp;0x7FFFFFFF.
814 </t>
815 <t>
816 It is normal and expected that the range decoder will read several bytes
817  into the raw bits data (if any) at the end of the packet by the time the frame
818  is completely decoded, as illustrated in <xref target="finalize-example"/>.
819 This same data MUST also be returned as raw bits when requested.
820 The encoder is expected to terminate the stream in such a way that the decoder
821  will decode the intended values regardless of the data contained in the raw
822  bits.
823 <xref target="encoder-finalizing"/> describes a procedure for doing this.
824 If the range decoder consumes all of the bytes belonging to the current frame,
825  it MUST continue to use zero when any further input bytes are required, even
826  if there is additional data in the current packet, from padding or other
827  frames.
828 </t>
829
830 <figure anchor="finalize-example" title="Illustrative example of raw bits
831  overlapping range coder data">
832 <artwork align="center"><![CDATA[
833  n               n+1             n+2             n+3
834  7 6 5 4 3 2 1 0 7 6 5 4 3 2 1 0 7 6 5 4 3 2 1 0 7 6 5 4 3 2 1 0
835 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
836 :     | <----------- Overlap region ------------> |             :
837 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
838       ^                                           ^
839       |   End of data buffered by the range coder |
840 ...-----------------------------------------------+
841       |
842       | End of data consumed by raw bits
843       +-------------------------------------------------------...
844 ]]></artwork>
845 </figure>
846 </section>
847 </section>
848
849 <section anchor="decoding-alternate" title="Alternate Decoding Methods">
850 <t>
851 The reference implementation uses three additional decoding methods that are
852  exactly equivalent to the above, but make assumptions and simplifications that
853  allow for a more efficient implementation.
854 </t>
855 <section title="ec_decode_bin()">
856 <t>
857 The first is ec_decode_bin() (entdec.c), defined using the parameter ftb
858  instead of ft.
859 It is mathematically equivalent to calling ec_decode() with
860  ft = (1&lt;&lt;ftb), but avoids one of the divisions.
861 </t>
862 </section>
863 <section title="ec_dec_bit_logp()">
864 <t>
865 The next is ec_dec_bit_logp() (entdec.c), which decodes a single binary symbol,
866  replacing both the ec_decode() and ec_dec_update() steps.
867 The context is described by a single parameter, logp, which is the absolute
868  value of the base-2 logarithm of the probability of a "1".
869 It is mathematically equivalent to calling ec_decode() with
870  ft = (1&lt;&lt;logp), followed by ec_dec_update() with
871  fl = 0, fh = (1&lt;&lt;logp)-1, ft = (1&lt;&lt;logp) if the returned value
872  of fs is less than (1&lt;&lt;logp)-1 (a "0" was decoded), and with
873  fl = (1&lt;&lt;logp)-1, fh = ft = (1&lt;&lt;logp) otherwise (a "1" was
874  decoded).
875 The implementation requires no multiplications or divisions.
876 </t>
877 </section>
878 <section title="ec_dec_icdf()">
879 <t>
880 The last is ec_dec_icdf() (entdec.c), which decodes a single symbol with a
881  table-based context of up to 8 bits, also replacing both the ec_decode() and
882  ec_dec_update() steps, as well as the search for the decoded symbol in between.
883 The context is described by two parameters, an icdf
884  (<spanx style="emph">inverse</spanx> cumulative distribution function)
885  table and ftb.
886 As with ec_decode_bin(), (1&lt;&lt;ftb) is equivalent to ft.
887 idcf[k], on the other hand, stores (1&lt;&lt;ftb)-fh for the kth symbol in
888  the context, which is equal to (1&lt;&lt;ftb)-fl for the (k+1)st symbol.
889 fl for the 0th symbol is assumed to be 0, and the table is terminated by a
890  value of 0 (where fh&nbsp;==&nbsp;ft).
891 </t>
892 <t>
893 The function is mathematically equivalent to calling ec_decode() with
894  ft = (1&lt;&lt;ftb), using the returned value fs to search the table for the
895  first entry where fs &lt; (1&lt;&lt;ftb)-icdf[k], and calling
896  ec_dec_update() with fl = (1&lt;&lt;ftb)-icdf[k-1] (or 0 if k&nbsp;==&nbsp;0),
897  fh = (1&lt;&lt;ftb)-idcf[k], and ft = (1&lt;&lt;ftb).
898 Combining the search with the update allows the division to be replaced by a
899  series of multiplications (which are usually much cheaper), and using an
900  inverse CDF allows the use of an ftb as large as 8 in an 8-bit table without
901  any special cases.
902 This is the primary interface with the range decoder in the SILK layer, though
903  it is used in a few places in the CELT layer as well.
904 </t>
905 <t>
906 Although icdf[k] is more convenient for the code, the frequency counts, f[k],
907  are a more natural representation of the probability distribution function
908  (PDF) for a given symbol.
909 Therefore this draft lists the latter, not the former, when describing the
910  context in which a symbol is coded as a list, e.g., {4, 4, 4, 4}/16 for a
911  uniform context with four possible values and ft=16.
912 The value of ft after the slash is always the sum of the entries in the PDF,
913  but is included for convenience.
914 Contexts with identical probabilities, f[k]/ft, but different values of ft
915  (or equivalently, ftb) are not the same, and cannot, in general, be used in
916  place of one another.
917 An icdf table is also not capable of representing a PDF where the first symbol
918  has 0 probability.
919 In such contexts, ec_dec_icdf() can decode the symbol by using a table that
920  drops the entries for any initial zero-probability values and adding the
921  constant offset of the first value with a non-zero probability to its return
922  value.
923 </t>
924 </section>
925 </section>
926
927 <section anchor="decoding-bits" title="Decoding Raw Bits">
928 <t>
929 The raw bits used by the CELT layer are packed at the end of the packet, with
930  the least significant bit of the first value to be packed in the least
931  significant bit of the last byte, filling up to the most significant bit in
932  the last byte, and continuing on to the least significant bit of the
933  penultimate byte, and so on.
934 The reference implementation reads them using ec_dec_bits() (entdec.c).
935 Because the range decoder must read several bytes ahead in the stream, as
936  described in <xref target="range-decoder-renorm"/>, the input consumed by the
937  raw bits MAY overlap with the input consumed by the range coder, and a decoder
938  MUST allow this.
939 The format should render it impossible to attempt to read more raw bits than
940  there are actual bits in the frame, though a decoder MAY wish to check for
941  this and report an error.
942 </t>
943 </section>
944
945 <section anchor="decoding-ints" title="Decoding Uniformly Distributed Integers">
946 <t>
947 The ec_dec_uint() (entdec.c) function decodes one of ft equiprobable values in
948  the range 0 to ft-1, inclusive, each with a frequency of 1, where ft may be as
949  large as 2**32-1.
950 Because ec_decode() is limited to a total frequency of 2**16-1, this is split
951  up into a range coded symbol representing up to 8 of the high bits of the
952  value, and, if necessary, raw bits representing the remaining bits.
953 The limit of 8 bits in the range coded symbol is a trade-off between
954  implementation complexity, modeling error (since the symbols no longer truly
955  have equal coding cost) and rounding error introduced by the range coder
956  itself (which gets larger as more bits are included).
957 Using raw bits reduces the maximum number of divisions required in the worst
958  case, but means that it may be possible to decode a value outside the range
959  0 to ft-1, inclusive.
960 </t>
961
962 <t>
963 ec_dec_uint() takes a single, positive parameter, ft, which is not necessarily
964  a power of two, and returns an integer, t, whose value lies between 0 and
965  ft-1, inclusive.
966 Let ftb = ilog(ft-1), i.e., the number of bits required to store ft-1 in two's
967  complement notation.
968 If ftb is 8 or less, then t is decoded with t = ec_decode(ft), and the range
969  coder state is updated using the three-tuple (t,t+1,ft).
970 </t>
971 <t>
972 If ftb is greater than 8, then the top 8 bits of t are decoded using
973  t = ec_decode((ft-1&gt;&gt;ftb-8)+1),
974  the decoder state is updated using the three-tuple
975  (t,t+1,(ft-1&gt;&gt;ftb-8)+1), and the remaining bits are decoded as raw bits,
976  setting t = t&lt;&lt;ftb-8|ec_dec_bits(ftb-8).
977 If, at this point, t >= ft, then the current frame is corrupt.
978 In that case, the decoder should assume there has been an error in the coding,
979  decoding, or transmission and SHOULD take measures to conceal the
980  error and/or report to the application that a problem has occurred.
981 </t>
982
983 </section>
984
985 <section anchor="decoder-tell" title="Current Bit Usage">
986 <t>
987 The bit allocation routines in the CELT decoder need a conservative upper bound
988  on the number of bits that have been used from the current frame thus far,
989  including both range coder bits and raw bits.
990 This drives allocation decisions that must match those made in the encoder.
991 The upper bound is computed in the reference implementation to whole-bit
992  precision by the function ec_tell() (entcode.h) and to fractional 1/8th bit
993  precision by the function ec_tell_frac() (entcode.c).
994 Like all operations in the range coder, it must be implemented in a bit-exact
995  manner, and must produce exactly the same value returned by the same functions
996  in the encoder after encoding the same symbols.
997 </t>
998 <t>
999 ec_tell() is guaranteed to return ceil(ec_tell_frac()/8.0).
1000 In various places the codec will check to ensure there is enough room to
1001  contain a symbol before attempting to decode it.
1002 In practice, although the number of bits used so far is an upper bound,
1003  decoding a symbol whose probability model suggests it has a worst-case cost of
1004  p 1/8th bits may actually advance the return value of ec_tell_frac() by
1005  p-1, p, or p+1 1/8th bits, due to approximation error in that upper bound,
1006  truncation error in the range coder, and for large values of ft, modeling
1007  error in ec_dec_uint().
1008 </t>
1009 <t>
1010 However, this error is bounded, and periodic calls to ec_tell() or
1011  ec_tell_frac() at precisely defined points in the decoding process prevent it
1012  from accumulating.
1013 For a symbol that requires a whole number of bits (i.e., ft/(fh-fl) is a power
1014  of two, including values of ft larger than 2**8 with ec_dec_uint()), and there
1015  are at least p 1/8th bits available, decoding the symbol will never advance
1016  the decoder past the end of the frame, i.e., will never
1017  <spanx style="emph">bust</spanx> the budget.
1018 Frames contain a whole number of bits, and the return value of ec_tell_frac()
1019  will only advance by more than p 1/8th bits in this case if there was a
1020  fractional number of bits remaining, and by no more than the fractional part.
1021 However, when p is not a whole number of bits, an extra 1/8th bit is required
1022  to ensure decoding the symbol will not bust.
1023 </t>
1024 <t>
1025 The reference implementation keeps track of the total number of whole bits that
1026  have been processed by the decoder so far in a variable nbits_total, including
1027  the (possibly fractional number of bits) that are currently buffered (but not
1028  consumed) inside the range coder.
1029 nbits_total is initialized to 33 just after the initial range renormalization
1030  process completes (or equivalently, it can be initialized to 9 before the
1031  first renormalization).
1032 The extra two bits over the actual amount buffered by the range coder
1033  guarantees that it is an upper bound and that there is enough room for the
1034  encoder to terminate the stream.
1035 Each iteration through the range coder's renormalization loop increases
1036  nbits_total by 8.
1037 Reading raw bits increases nbits_total by the number of raw bits read.
1038 </t>
1039
1040 <section anchor="ec_tell" title="ec_tell()">
1041 <t>
1042 The whole number of bits buffered in rng may be estimated via l = ilog(rng).
1043 ec_tell() then becomes a simple matter of removing these bits from the total.
1044 It returns (nbits_total - l).
1045 </t>
1046 <t>
1047 In a newly initialized decoder, before any symbols have been read, this reports
1048  that 1 bit has been used.
1049 This is the bit reserved for termination of the encoder.
1050 </t>
1051 </section>
1052
1053 <section anchor="ec_tell_frac" title="ec_tell_frac()">
1054 <t>
1055 ec_tell_frac() estimates the number of bits buffered in rng to fractional
1056  precision.
1057 Since rng must be greater than 2**23 after renormalization, l must be at least
1058  24.
1059 Let r = rng&gt;&gt;(l-16), so that 32768 &lt;= r &lt; 65536, an unsigned Q15
1060  value representing the fractional part of rng.
1061 Then the following procedure can be used to add one bit of precision to l.
1062 First, update r = r*r&gt;&gt;15.
1063 Then add the 16th bit of r to l via l = 2*l + (r&gt;&gt;16).
1064 Finally, if this bit was a 1, reduce r by a factor of two via r = r&gt;&gt;1,
1065  so that it once again lies in the range 32768 &lt;= r &lt; 65536.
1066 </t>
1067 <t>
1068 This procedure is repeated three times to extend l to 1/8th bit precision.
1069 ec_tell_frac() then returns (nbits_total*8 - l).
1070 </t>
1071 </section>
1072
1073 </section>
1074
1075 </section>
1076
1077 <section anchor='outline_decoder' title='SILK Decoder'>
1078 <t>
1079 The decoder's LP layer uses a modified version of the SILK codec (herein simply
1080  called "SILK"), which runs a decoded excitation signal through adaptive
1081  long-term and short-term prediction synthesis filters.
1082 It runs in NB, MB, and WB modes internally.
1083 When used in a hybrid frame in SWB or FB mode, the LP layer itself still only
1084  runs in WB mode.
1085 </t>
1086 <t>
1087 Internally, the LP layer of a single Opus frame is composed of either a single
1088  10&nbsp;ms SILK frame or between one and three 20&nbsp;ms SILK frames.
1089 Each SILK frame is in turn composed of either two or four 5&nbsp;ms subframes.
1090 Optional Low Bit-Rate Redundancy (LBRR) frames, which are reduced-bitrate
1091  encodings of previous SILK frames, may appear to aid in recovery from packet
1092  loss.
1093 If present, these appear before the regular SILK frames.
1094 They are in most respects identical to regular active SILK frames, except that
1095  they are usually encoded with a lower bitrate, and from here on this draft
1096  will use "SILK frame" to refer to either one and "regular SILK frame" if it
1097  needs to draw a distinction between the two.
1098 </t>
1099 <t>
1100 All of these frames and subframes are decoded from the same range coder, with
1101  no padding between them.
1102 Thus packing multiple SILK frames in a single Opus frame saves, on average,
1103  half a byte per SILK frame.
1104 It also allows some parameters to be predicted from prior SILK frames in the
1105  same Opus frame, since this does not degrade packet loss robustness (beyond
1106  any penalty for merely using fewer, larger packets to store multiple frames).
1107 </t>
1108
1109 <t>
1110 Stereo support in SILK uses a variant of mid-side coding, allowing a mono
1111  decoder to simply decode the mid channel.
1112 However, the data for the two channels is interleaved, so a mono decoder must
1113  still unpack the data for the side channel.
1114 It would be required to do so anyway for hybrid Opus frames, or to support
1115  decoding individual 20&nbsp;ms frames.
1116 </t>
1117
1118 <texttable anchor="silk_symbols">
1119 <ttcol align="center">Symbol(s)</ttcol>
1120 <ttcol align="center">PDF</ttcol>
1121 <ttcol align="center">Condition</ttcol>
1122 <c>VAD flags</c>     <c>{1, 1}/2</c>                    <c></c>
1123 <c>LBRR flag</c>     <c>{1, 1}/2</c>                    <c></c>
1124 <c>Per-frame LBRR flags</c> <c><xref target="silk_lbrr_flags"/></c> <c><xref target="silk_lbrr_flags"/></c>
1125 <c>Frame Type</c>    <c><xref target="silk_frame_type"/></c>    <c></c>
1126 <c>Gain index</c>    <c><xref target="silk_gains"/></c> <c></c>
1127 <postamble>
1128 Order of the symbols in the SILK section of the bit-stream.
1129 </postamble>
1130 </texttable>
1131
1132 <section title="Decoder Modules">
1133 <t>
1134 An overview of the decoder is given in <xref target="decoder_figure"/>.
1135 </t>
1136 <figure align="center" anchor="decoder_figure">
1137 <artwork align="center">
1138 <![CDATA[
1139
1140    +---------+    +------------+
1141 -->| Range   |--->| Decode     |---------------------------+
1142  1 | Decoder | 2  | Parameters |----------+       5        |
1143    +---------+    +------------+     4    |                |
1144                        3 |                |                |
1145                         \/               \/               \/
1146                   +------------+   +------------+   +------------+
1147                   | Generate   |-->| LTP        |-->| LPC        |-->
1148                   | Excitation |   | Synthesis  |   | Synthesis  | 6
1149                   +------------+   +------------+   +------------+
1150
1151 1: Range encoded bitstream
1152 2: Coded parameters
1153 3: Pulses and gains
1154 4: Pitch lags and LTP coefficients
1155 5: LPC coefficients
1156 6: Decoded signal
1157 ]]>
1158 </artwork>
1159 <postamble>Decoder block diagram.</postamble>
1160 </figure>
1161
1162           <section title='Range Decoder'>
1163             <t>
1164               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.
1165             </t>
1166           </section>
1167
1168           <section title='Decode Parameters'>
1169             <t>
1170               Pulses and gains are decoded from the parameters that were decoded by the range decoder.
1171             </t>
1172
1173             <t>
1174               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.
1175               The LPC coefficients are decoded from the LSF codebook by first adding the chosen LSF vector and the decoded LSF residual signal. The resulting LSF vector is stabilized using the same method that was used in the encoder, see
1176               <xref target='lsf_stabilizer_overview_section' />. The LSF coefficients are then converted to LPC coefficients, and passed on to the LPC synthesis filter.
1177             </t>
1178           </section>
1179
1180           <section title='Generate Excitation'>
1181             <t>
1182               The pulses signal is multiplied with the quantization gain to create the excitation signal.
1183             </t>
1184           </section>
1185
1186           <section title='LTP Synthesis'>
1187             <t>
1188               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
1189               <figure align="center">
1190                 <artwork align="center">
1191                   <![CDATA[
1192                    d
1193                   __
1194 e_LPC(n) = e(n) + \  e_LPC(n - L - i) * b_i,
1195                   /_
1196                  i=-d
1197 ]]>
1198                 </artwork>
1199               </figure>
1200               using the pitch lag L, and the decoded LTP coefficients b_i.
1201               The number of LTP coefficients is 5, and thus d&nbsp;=&nbsp;2.
1202
1203               For unvoiced speech, the output signal is simply a copy of the excitation signal, i.e., e_LPC(n) = e(n).
1204             </t>
1205           </section>
1206
1207           <section title='LPC Synthesis'>
1208             <t>
1209               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
1210               <figure align="center">
1211                 <artwork align="center">
1212                   <![CDATA[
1213                  d_LPC
1214                   __
1215 y(n) = e_LPC(n) + \  y(n - i) * a_i,
1216                   /_
1217                   i=1
1218 ]]>
1219                 </artwork>
1220               </figure>
1221               where d_LPC is the LPC synthesis filter order, and y(n) is the decoded output signal.
1222             </t>
1223           </section>
1224         </section>
1225
1226 <!--TODO: Document mandated decoder resets-->
1227
1228 <section title="Header Bits">
1229 <t>
1230 The LP layer begins with two to eight header bits, decoded in silk_Decode()
1231  (silk_dec_API.c).
1232 These consist of one Voice Activity Detection (VAD) bit per frame (up to 3),
1233  followed by a single flag indicating the presence of LBRR frames.
1234 For a stereo packet, these flags correspond to the mid channel, and a second
1235  set of flags is included for the side channel.
1236 </t>
1237 <t>
1238 Because these are the first symbols decoded by the range coder, they can be
1239  extracted directly from the upper bits of the first byte of compressed data.
1240 Thus, a receiver can determine if an Opus frame contains any active SILK frames
1241  without the overhead of using the range decoder.
1242 </t>
1243 </section>
1244
1245 <section anchor="silk_lbrr_flags" title="LBRR Flags">
1246 <t>
1247 For Opus frames longer than 20&nbsp;ms, a set of per-frame LBRR flags is
1248  decoded for each channel that has its LBRR flag set.
1249 For 40&nbsp;ms Opus frames the 2-frame LBRR flag PDF from
1250  <xref target="silk_lbrr_flag_pdfs"/> is used, and for 60&nbsp;ms Opus frames
1251  the 3-frame LBRR flag PDF is used.
1252 For each channel, the resulting 2- or 3-bit integer contains the corresponding
1253  LBRR flag for each frame, packed in order from the LSb to the MSb.
1254 </t>
1255
1256 <texttable anchor="silk_lbrr_flag_pdfs" title="LBRR Flag PDFs">
1257 <ttcol>Frame Size</ttcol>
1258 <ttcol>PDF</ttcol>
1259 <c>40&nbsp;ms</c> <c>{0, 53, 53, 150}/256</c>
1260 <c>60&nbsp;ms</c> <c>{0, 41, 20, 29, 41, 15, 28, 82}/256</c>
1261 </texttable>
1262
1263 <t>
1264 LBRR frames do not include their own separate VAD flags.
1265 An LBRR frame is only meant to be transmitted for active speech, thus all LBRR
1266  frames are treated as active.
1267 </t>
1268 </section>
1269
1270 <section title="SILK Frame Contents">
1271 <t>
1272 Each SILK frame includes a set of side information that encodes the frame type,
1273  quantization type and gains, short-term prediction filter coefficients, LSF
1274  interpolation weight, long-term prediction filter lags and gains, and a
1275  pseudorandom number generator (PRNG) seed.
1276 This is followed by the quantized excitation signal.
1277 </t>
1278 <section anchor="silk_frame_type" title="Frame Type">
1279 <t>
1280 Each SILK frame begins with a single <spanx style="emph">frame type</spanx>
1281  symbol that jointly codes the signal type and quantization offset type of the
1282  corresponding frame.
1283 If the current frame is a regular SILK frame whose VAD bit was not set (an
1284  <spanx style="emph">inactive</spanx> frame), then the frame type symbol takes
1285  on the value either 0 or 1 and is decoded using the first PDF in
1286  <xref target="silk_frame_type_pdfs"/>.
1287 If the frame is an LBRR frame or a regular SILK frame whose VAD flag was set
1288  (an <spanx style="emph">active</spanx> frame), then the symbol ranges from 2
1289  to 5, inclusive, and is decoded using the second PDF in
1290  <xref target="silk_frame_type_pdfs"/>.
1291 <xref target="silk_frame_type_table"/> translates between the value of the
1292  frame type symbol and the corresponding signal type and quantization offset
1293  type.
1294 </t>
1295
1296 <texttable anchor="silk_frame_type_pdfs" title="Frame Type PDFs">
1297 <ttcol>VAD Flag</ttcol>
1298 <ttcol>PDF</ttcol>
1299 <c>Inactive</c> <c>{26, 230, 0, 0, 0, 0}/256</c>
1300 <c>Active</c>   <c>{0, 0, 24, 74, 148, 10}/256</c>
1301 </texttable>
1302
1303 <texttable anchor="silk_frame_type_table"
1304  title="Signal Type and Quantization Offset Type from Frame Type">
1305 <ttcol>Frame Type</ttcol>
1306 <ttcol>Signal Type</ttcol>
1307 <ttcol align="right">Quantization Offset Type</ttcol>
1308 <c>0</c> <c>Inactive</c> <c>0</c>
1309 <c>1</c> <c>Inactive</c> <c>1</c>
1310 <c>2</c> <c>Unvoiced</c> <c>0</c>
1311 <c>3</c> <c>Unvoiced</c> <c>1</c>
1312 <c>4</c> <c>Voiced</c>   <c>0</c>
1313 <c>5</c> <c>Voiced</c>   <c>1</c>
1314 </texttable>
1315
1316 </section>
1317
1318 <section anchor="silk_gains" title="Sub-Frame Gains">
1319 <t>
1320 A separate quantization gain is coded for each 5&nbsp;ms subframe.
1321 These gains control the step size between quantization levels of the excitation
1322  signal and, therefore, the quality of the reconstruction.
1323 They are independent of the pitch gains coded for voiced frames.
1324 The quantization gains are themselves uniformly quantized to 6&nbsp;bits on a
1325  log scale, giving them a resolution of approximately 1.369&nbsp;dB and a range
1326  of approximately 1.94&nbsp;dB to 88.21&nbsp;dB.
1327 </t>
1328 <t>
1329 For the first LBRR frame, an LBRR frame where the previous LBRR frame was not
1330  coded, or the first regular SILK frame in an Opus frame, the first subframe
1331  uses an independent coding method.
1332 The 3 most significant bits of the quantization gain are decoded using a PDF
1333  selected from <xref target="silk_independent_gain_msb_pdfs"/> based on the
1334  decoded signal type.
1335 </t>
1336
1337 <texttable anchor="silk_independent_gain_msb_pdfs"
1338  title="PDFs for Independent Quantization Gain MSb Coding">
1339 <ttcol align="left">Signal Type</ttcol>
1340 <ttcol align="left">PDF</ttcol>
1341 <c>Inactive</c> <c>{32, 112, 68, 29, 12,  1,  1, 1}/256</c>
1342 <c>Unvoiced</c> <c>{2,   17, 45, 60, 62, 47, 19, 4}/256</c>
1343 <c>Voiced</c>   <c>{1,    3, 26, 71, 94, 50,  9, 2}/256</c>
1344 </texttable>
1345
1346 <t>
1347 The 3 least significant bits are decoded using a uniform PDF:
1348 </t>
1349 <texttable anchor="silk_independent_gain_lsb_pdf"
1350  title="PDF for Independent Quantization Gain LSb Coding">
1351 <ttcol align="left">PDF</ttcol>
1352 <c>{32, 32, 32, 32, 32, 32, 32, 32}/256</c>
1353 </texttable>
1354
1355 <t>
1356 For all other subframes (including the first subframe of frames not listed as
1357  using independent coding above), the quantization gain is coded relative to
1358  the gain from the previous subframe.
1359 The PDF in <xref target="silk_delta_gain_pdf"/> yields a delta gain index
1360  between 0 and 40, inclusive.
1361 </t>
1362 <texttable anchor="silk_delta_gain_pdf"
1363  title="PDF for Delta Quantization Gain Coding">
1364 <ttcol align="left">PDF</ttcol>
1365 <c>{6,   5,  11,  31, 132,  21,   8,   4,
1366     3,   2,   2,   2,   1,   1,   1,   1,
1367     1,   1,   1,   1,   1,   1,   1,   1,
1368     1,   1,   1,   1,   1,   1,   1,   1,
1369     1,   1,   1,   1,   1,   1,   1,   1,   1}/256</c>
1370 </texttable>
1371 <t>
1372 The following formula translates this index into a quantization gain for the
1373  current subframe using the gain from the previous subframe:
1374 </t>
1375 <figure align="center">
1376 <artwork align="center"><![CDATA[
1377 log_gain = min(max(2*gain_index - 16,
1378                    previous_log_gain + gain_index - 4), 63)
1379 ]]></artwork>
1380 </figure>
1381 <t>
1382 silk_gains_dequant() (silk_gain_quant.c) dequantizes the gain for the
1383  <spanx style="emph">k</spanx>th subframe and converts it into a linear Q16
1384  scale factor via
1385 </t>
1386 <figure align="center">
1387 <artwork align="center"><![CDATA[
1388 gain_Q16[k] = silk_log2lin((0x1D1C71*log_gain>>16) + 2090)
1389 ]]></artwork>
1390 </figure>
1391 <t>
1392 The function silk_log2lin() (silk_log2lin.c) computes an approximation of
1393  of 2**(inLog_Q7/128.0), where inLog_Q7 is its Q7 input.
1394 Let i = inLog_Q7&gt;&gt;7 be the integer part of inLogQ7 and
1395  f = inLog_Q7&amp;127 be the fractional part.
1396 Then, if i &lt; 16, then
1397 <figure align="center">
1398 <artwork align="center"><![CDATA[
1399 (1<<i) + (((-174*f*(128-f)>>16)+f)>>7)*(1<<i)
1400 ]]></artwork>
1401 </figure>
1402  yields the approximate exponential.
1403 Otherwise, silk_log2lin uses
1404 <figure align="center">
1405 <artwork align="center"><![CDATA[
1406 (1<<i) + ((-174*f*(128-f)>>16)+f)*((1<<i)>>7) .
1407 ]]></artwork>
1408 </figure>
1409 </t>
1410 </section>
1411
1412 <section anchor="silk_nlsfs" title="Normalized Line Spectral Frequencies">
1413
1414 <t>
1415 Normalized Line Spectral Frequencies (LSFs) follow the quantization gains in
1416  the bitstream, and represent the Linear Prediction Coefficients (LPCs) for the
1417  current SILK frame.
1418 Once decoded, they form an increasing list of Q15 values between 0 and 1.
1419 These represent the interleaved zeros on the unit circle between 0 and pi
1420  (hence "normalized") in the standard decomposition of the LPC filter into a
1421  symmetric part and an anti-symmetric part (P and Q in
1422  <xref target="silk_nlsf2lpc"/>).
1423 Because of non-linear effects in the decoding process, an implementation SHOULD
1424  match the fixed-point arithmetic described in this section exactly.
1425 An encoder SHOULD also use the same process.
1426 </t>
1427 <t>
1428 The normalized LSFs are coded using a two-stage vector quantizer (VQ).
1429 NB and MB frames use an order-10 predictor, while WB frames use an order-16
1430  predictor, and thus have different sets of tables.
1431 The first VQ stage uses a 32-element codebook, coded with one of the PDFs in
1432  <xref target="silk_nlsf_stage1_pdfs"/>, depending on the audio bandwidth and
1433  the signal type of the current SILK frame.
1434 This yields a single index, <spanx style="emph">I1</spanx>, for the entire
1435  frame.
1436 This indexes an element in a coarse codebook, selects the PDFs for the
1437  second stage of the VQ, and selects the prediction weights used to remove
1438  intra-frame redundancy from the second stage.
1439 The actual codebook elements are listed in
1440  <xref target="silk_nlsf_nbmb_codebook"/> and
1441  <xref target="silk_nlsf_wb_codebook"/>, but they are not needed until the last
1442  stages of reconstructing the LSF coefficients.
1443 </t>
1444
1445 <texttable anchor="silk_nlsf_stage1_pdfs"
1446  title="PDFs for Normalized LSF Index Stage-1 Decoding">
1447 <ttcol align="left">Audio Bandwidth</ttcol>
1448 <ttcol align="left">Signal Type</ttcol>
1449 <ttcol align="left">PDF</ttcol>
1450 <c>NB or MB</c> <c>Inactive or unvoiced</c>
1451 <c>
1452 {44, 34, 30, 19, 21, 12, 11,  3,
1453   3,  2, 16,  2,  2,  1,  5,  2,
1454   1,  3,  3,  1,  1,  2,  2,  2,
1455   3,  1,  9,  9,  2,  7,  2,  1}/256
1456 </c>
1457 <c>NB or MB</c> <c>Voiced</c>
1458 <c>
1459 {1, 10,  1,  8,  3,  8,  8, 14,
1460 13, 14,  1, 14, 12, 13, 11, 11,
1461 12, 11, 10, 10, 11,  8,  9,  8,
1462  7,  8,  1,  1,  6,  1,  6,  5}/256
1463 </c>
1464 <c>WB</c> <c>Inactive or unvoiced</c>
1465 <c>
1466 {31, 21,  3, 17,  1,  8, 17,  4,
1467   1, 18, 16,  4,  2,  3,  1, 10,
1468   1,  3, 16, 11, 16,  2,  2,  3,
1469   2, 11,  1,  4,  9,  8,  7,  3}/256
1470 </c>
1471 <c>WB</c> <c>Voiced</c>
1472 <c>
1473 {1,  4, 16,  5, 18, 11,  5, 14,
1474 15,  1,  3, 12, 13, 14, 14,  6,
1475 14, 12,  2,  6,  1, 12, 12, 11,
1476 10,  3, 10,  5,  1,  1,  1,  3}/256
1477 </c>
1478 </texttable>
1479
1480 <t>
1481 A total of 16 PDFs are available for the LSF residual in the second stage: the
1482  8 (a...h) for NB and MB frames given in
1483  <xref target="silk_nlsf_stage2_nbmb_pdfs"/>, and the 8 (i...p) for WB frames
1484  given in <xref target="silk_nlsf_stage2_wb_pdfs"/>.
1485 Which PDF is used for which coefficient is driven by the index, I1,
1486  decoded in the first stage.
1487 <xref target="silk_nlsf_nbmb_stage2_cb_sel"/> lists the letter of the
1488  corresponding PDF for each normalized LSF coefficient for NB and MB, and
1489  <xref target="silk_nlsf_wb_stage2_cb_sel"/> lists the same information for WB.
1490 </t>
1491
1492 <texttable anchor="silk_nlsf_stage2_nbmb_pdfs"
1493  title="PDFs for NB/MB Normalized LSF Index Stage-2 Decoding">
1494 <ttcol align="left">Codebook</ttcol>
1495 <ttcol align="left">PDF</ttcol>
1496 <c>a</c> <c>{1,   1,   1,  15, 224,  11,   1,   1,   1}/256</c>
1497 <c>b</c> <c>{1,   1,   2,  34, 183,  32,   1,   1,   1}/256</c>
1498 <c>c</c> <c>{1,   1,   4,  42, 149,  55,   2,   1,   1}/256</c>
1499 <c>d</c> <c>{1,   1,   8,  52, 123,  61,   8,   1,   1}/256</c>
1500 <c>e</c> <c>{1,   3,  16,  53, 101,  74,   6,   1,   1}/256</c>
1501 <c>f</c> <c>{1,   3,  17,  55,  90,  73,  15,   1,   1}/256</c>
1502 <c>g</c> <c>{1,   7,  24,  53,  74,  67,  26,   3,   1}/256</c>
1503 <c>h</c> <c>{1,   1,  18,  63,  78,  58,  30,   6,   1}/256</c>
1504 </texttable>
1505
1506 <texttable anchor="silk_nlsf_stage2_wb_pdfs"
1507  title="PDFs for WB Normalized LSF Index Stage-2 Decoding">
1508 <ttcol align="left">Codebook</ttcol>
1509 <ttcol align="left">PDF</ttcol>
1510 <c>i</c> <c>{1,   1,   1,   9, 232,   9,   1,   1,   1}/256</c>
1511 <c>j</c> <c>{1,   1,   2,  28, 186,  35,   1,   1,   1}/256</c>
1512 <c>k</c> <c>{1,   1,   3,  42, 152,  53,   2,   1,   1}/256</c>
1513 <c>l</c> <c>{1,   1,  10,  49, 126,  65,   2,   1,   1}/256</c>
1514 <c>m</c> <c>{1,   4,  19,  48, 100,  77,   5,   1,   1}/256</c>
1515 <c>n</c> <c>{1,   1,  14,  54, 100,  72,  12,   1,   1}/256</c>
1516 <c>o</c> <c>{1,   1,  15,  61,  87,  61,  25,   4,   1}/256</c>
1517 <c>p</c> <c>{1,   7,  21,  50,  77,  81,  17,   1,   1}/256</c>
1518 </texttable>
1519
1520 <texttable anchor="silk_nlsf_nbmb_stage2_cb_sel"
1521  title="Codebook Selection for NB/MB Normalized LSF Index Stage 2 Decoding">
1522 <ttcol>I1</ttcol>
1523 <ttcol>Coefficient</ttcol>
1524 <c/>
1525 <c><spanx style="vbare">0&nbsp;1&nbsp;2&nbsp;3&nbsp;4&nbsp;5&nbsp;6&nbsp;7&nbsp;8&nbsp;9</spanx></c>
1526 <c> 0</c>
1527 <c><spanx style="vbare">a&nbsp;a&nbsp;a&nbsp;a&nbsp;a&nbsp;a&nbsp;a&nbsp;a&nbsp;a&nbsp;a</spanx></c>
1528 <c> 1</c>
1529 <c><spanx style="vbare">b&nbsp;d&nbsp;b&nbsp;c&nbsp;c&nbsp;b&nbsp;c&nbsp;b&nbsp;b&nbsp;b</spanx></c>
1530 <c> 2</c>
1531 <c><spanx style="vbare">c&nbsp;b&nbsp;b&nbsp;b&nbsp;b&nbsp;b&nbsp;b&nbsp;b&nbsp;b&nbsp;b</spanx></c>
1532 <c> 3</c>
1533 <c><spanx style="vbare">b&nbsp;c&nbsp;c&nbsp;c&nbsp;c&nbsp;b&nbsp;c&nbsp;b&nbsp;b&nbsp;b</spanx></c>
1534 <c> 4</c>
1535 <c><spanx style="vbare">c&nbsp;d&nbsp;d&nbsp;d&nbsp;d&nbsp;c&nbsp;c&nbsp;c&nbsp;c&nbsp;c</spanx></c>
1536 <c> 5</c>
1537 <c><spanx style="vbare">a&nbsp;f&nbsp;d&nbsp;d&nbsp;c&nbsp;c&nbsp;c&nbsp;c&nbsp;b&nbsp;b</spanx></c>
1538 <c> g</c>
1539 <c><spanx style="vbare">a&nbsp;c&nbsp;c&nbsp;c&nbsp;c&nbsp;c&nbsp;c&nbsp;c&nbsp;c&nbsp;b</spanx></c>
1540 <c> 7</c>
1541 <c><spanx style="vbare">c&nbsp;d&nbsp;g&nbsp;e&nbsp;e&nbsp;e&nbsp;f&nbsp;e&nbsp;f&nbsp;f</spanx></c>
1542 <c> 8</c>
1543 <c><spanx style="vbare">c&nbsp;e&nbsp;f&nbsp;f&nbsp;e&nbsp;f&nbsp;e&nbsp;g&nbsp;e&nbsp;e</spanx></c>
1544 <c> 9</c>
1545 <c><spanx style="vbare">c&nbsp;e&nbsp;e&nbsp;h&nbsp;e&nbsp;f&nbsp;e&nbsp;f&nbsp;f&nbsp;e</spanx></c>
1546 <c>10</c>
1547 <c><spanx style="vbare">e&nbsp;d&nbsp;d&nbsp;d&nbsp;c&nbsp;d&nbsp;c&nbsp;c&nbsp;c&nbsp;c</spanx></c>
1548 <c>11</c>
1549 <c><spanx style="vbare">b&nbsp;f&nbsp;f&nbsp;g&nbsp;e&nbsp;f&nbsp;e&nbsp;f&nbsp;f&nbsp;f</spanx></c>
1550 <c>12</c>
1551 <c><spanx style="vbare">c&nbsp;h&nbsp;e&nbsp;g&nbsp;f&nbsp;f&nbsp;f&nbsp;f&nbsp;f&nbsp;f</spanx></c>
1552 <c>13</c>
1553 <c><spanx style="vbare">c&nbsp;h&nbsp;f&nbsp;f&nbsp;f&nbsp;f&nbsp;f&nbsp;g&nbsp;f&nbsp;e</spanx></c>
1554 <c>14</c>
1555 <c><spanx style="vbare">d&nbsp;d&nbsp;f&nbsp;e&nbsp;e&nbsp;f&nbsp;e&nbsp;f&nbsp;e&nbsp;e</spanx></c>
1556 <c>15</c>
1557 <c><spanx style="vbare">c&nbsp;d&nbsp;d&nbsp;f&nbsp;f&nbsp;e&nbsp;e&nbsp;e&nbsp;e&nbsp;e</spanx></c>
1558 <c>16</c>
1559 <c><spanx style="vbare">c&nbsp;e&nbsp;e&nbsp;g&nbsp;e&nbsp;f&nbsp;e&nbsp;f&nbsp;f&nbsp;f</spanx></c>
1560 <c>17</c>
1561 <c><spanx style="vbare">c&nbsp;f&nbsp;e&nbsp;g&nbsp;f&nbsp;f&nbsp;f&nbsp;e&nbsp;f&nbsp;e</spanx></c>
1562 <c>18</c>
1563 <c><spanx style="vbare">c&nbsp;h&nbsp;e&nbsp;f&nbsp;e&nbsp;f&nbsp;e&nbsp;f&nbsp;f&nbsp;f</spanx></c>
1564 <c>19</c>
1565 <c><spanx style="vbare">c&nbsp;f&nbsp;e&nbsp;g&nbsp;h&nbsp;g&nbsp;f&nbsp;g&nbsp;f&nbsp;e</spanx></c>
1566 <c>20</c>
1567 <c><spanx style="vbare">d&nbsp;g&nbsp;h&nbsp;e&nbsp;g&nbsp;f&nbsp;f&nbsp;g&nbsp;e&nbsp;f</spanx></c>
1568 <c>21</c>
1569 <c><spanx style="vbare">c&nbsp;h&nbsp;g&nbsp;e&nbsp;e&nbsp;e&nbsp;f&nbsp;e&nbsp;f&nbsp;f</spanx></c>
1570 <c>22</c>
1571 <c><spanx style="vbare">e&nbsp;f&nbsp;f&nbsp;e&nbsp;g&nbsp;g&nbsp;f&nbsp;g&nbsp;f&nbsp;e</spanx></c>
1572 <c>23</c>
1573 <c><spanx style="vbare">c&nbsp;f&nbsp;f&nbsp;g&nbsp;f&nbsp;g&nbsp;e&nbsp;g&nbsp;e&nbsp;e</spanx></c>
1574 <c>24</c>
1575 <c><spanx style="vbare">e&nbsp;f&nbsp;f&nbsp;f&nbsp;d&nbsp;h&nbsp;e&nbsp;f&nbsp;f&nbsp;e</spanx></c>
1576 <c>25</c>
1577 <c><spanx style="vbare">c&nbsp;d&nbsp;e&nbsp;f&nbsp;f&nbsp;g&nbsp;e&nbsp;f&nbsp;f&nbsp;e</spanx></c>
1578 <c>26</c>
1579 <c><spanx style="vbare">c&nbsp;d&nbsp;c&nbsp;d&nbsp;d&nbsp;e&nbsp;c&nbsp;d&nbsp;d&nbsp;d</spanx></c>
1580 <c>27</c>
1581 <c><spanx style="vbare">b&nbsp;b&nbsp;c&nbsp;c&nbsp;c&nbsp;c&nbsp;c&nbsp;d&nbsp;c&nbsp;c</spanx></c>
1582 <c>28</c>
1583 <c><spanx style="vbare">e&nbsp;f&nbsp;f&nbsp;g&nbsp;g&nbsp;g&nbsp;f&nbsp;g&nbsp;e&nbsp;f</spanx></c>
1584 <c>29</c>
1585 <c><spanx style="vbare">d&nbsp;f&nbsp;f&nbsp;e&nbsp;e&nbsp;e&nbsp;e&nbsp;d&nbsp;d&nbsp;c</spanx></c>
1586 <c>30</c>
1587 <c><spanx style="vbare">c&nbsp;f&nbsp;d&nbsp;h&nbsp;f&nbsp;f&nbsp;e&nbsp;e&nbsp;f&nbsp;e</spanx></c>
1588 <c>31</c>
1589 <c><spanx style="vbare">e&nbsp;e&nbsp;f&nbsp;e&nbsp;f&nbsp;g&nbsp;f&nbsp;g&nbsp;f&nbsp;e</spanx></c>
1590 </texttable>
1591
1592 <texttable anchor="silk_nlsf_wb_stage2_cb_sel"
1593  title="Codebook Selection for WB Normalized LSF Index Stage 2 Decoding">
1594 <ttcol>I1</ttcol>
1595 <ttcol>Coefficient</ttcol>
1596 <c/>
1597 <c><spanx style="vbare">0&nbsp;&nbsp;1&nbsp;&nbsp;2&nbsp;&nbsp;3&nbsp;&nbsp;4&nbsp;&nbsp;5&nbsp;&nbsp;6&nbsp;&nbsp;7&nbsp;&nbsp;8&nbsp;&nbsp;9&nbsp;10&nbsp;11&nbsp;12&nbsp;13&nbsp;14&nbsp;15</spanx></c>
1598 <c> 0</c>
1599 <c><spanx style="vbare">i&nbsp;&nbsp;i&nbsp;&nbsp;i&nbsp;&nbsp;i&nbsp;&nbsp;i&nbsp;&nbsp;i&nbsp;&nbsp;i&nbsp;&nbsp;i&nbsp;&nbsp;i&nbsp;&nbsp;i&nbsp;&nbsp;i&nbsp;&nbsp;i&nbsp;&nbsp;i&nbsp;&nbsp;i&nbsp;&nbsp;i&nbsp;&nbsp;i</spanx></c>
1600 <c> 1</c>
1601 <c><spanx style="vbare">k&nbsp;&nbsp;l&nbsp;&nbsp;l&nbsp;&nbsp;l&nbsp;&nbsp;l&nbsp;&nbsp;l&nbsp;&nbsp;k&nbsp;&nbsp;k&nbsp;&nbsp;k&nbsp;&nbsp;k&nbsp;&nbsp;k&nbsp;&nbsp;j&nbsp;&nbsp;j&nbsp;&nbsp;j&nbsp;&nbsp;i&nbsp;&nbsp;l</spanx></c>
1602 <c> 2</c>
1603 <c><spanx style="vbare">k&nbsp;&nbsp;n&nbsp;&nbsp;n&nbsp;&nbsp;l&nbsp;&nbsp;p&nbsp;&nbsp;m&nbsp;&nbsp;m&nbsp;&nbsp;n&nbsp;&nbsp;k&nbsp;&nbsp;n&nbsp;&nbsp;m&nbsp;&nbsp;n&nbsp;&nbsp;n&nbsp;&nbsp;m&nbsp;&nbsp;l&nbsp;&nbsp;l</spanx></c>
1604 <c> 3</c>
1605 <c><spanx style="vbare">i&nbsp;&nbsp;k&nbsp;&nbsp;j&nbsp;&nbsp;k&nbsp;&nbsp;k&nbsp;&nbsp;j&nbsp;&nbsp;j&nbsp;&nbsp;j&nbsp;&nbsp;j&nbsp;&nbsp;j&nbsp;&nbsp;i&nbsp;&nbsp;i&nbsp;&nbsp;i&nbsp;&nbsp;i&nbsp;&nbsp;i&nbsp;&nbsp;j</spanx></c>
1606 <c> 4</c>
1607 <c><spanx style="vbare">i&nbsp;&nbsp;o&nbsp;&nbsp;n&nbsp;&nbsp;m&nbsp;&nbsp;o&nbsp;&nbsp;m&nbsp;&nbsp;p&nbsp;&nbsp;n&nbsp;&nbsp;m&nbsp;&nbsp;m&nbsp;&nbsp;m&nbsp;&nbsp;n&nbsp;&nbsp;n&nbsp;&nbsp;m&nbsp;&nbsp;m&nbsp;&nbsp;l</spanx></c>
1608 <c> 5</c>
1609 <c><spanx style="vbare">i&nbsp;&nbsp;l&nbsp;&nbsp;n&nbsp;&nbsp;n&nbsp;&nbsp;m&nbsp;&nbsp;l&nbsp;&nbsp;l&nbsp;&nbsp;n&nbsp;&nbsp;l&nbsp;&nbsp;l&nbsp;&nbsp;l&nbsp;&nbsp;l&nbsp;&nbsp;l&nbsp;&nbsp;l&nbsp;&nbsp;k&nbsp;&nbsp;m</spanx></c>
1610 <c> 6</c>
1611 <c><spanx style="vbare">i&nbsp;&nbsp;i&nbsp;&nbsp;i&nbsp;&nbsp;i&nbsp;&nbsp;i&nbsp;&nbsp;i&nbsp;&nbsp;i&nbsp;&nbsp;i&nbsp;&nbsp;i&nbsp;&nbsp;i&nbsp;&nbsp;i&nbsp;&nbsp;i&nbsp;&nbsp;i&nbsp;&nbsp;i&nbsp;&nbsp;i&nbsp;&nbsp;i</spanx></c>
1612 <c> 7</c>
1613 <c><spanx style="vbare">i&nbsp;&nbsp;k&nbsp;&nbsp;o&nbsp;&nbsp;l&nbsp;&nbsp;p&nbsp;&nbsp;k&nbsp;&nbsp;n&nbsp;&nbsp;l&nbsp;&nbsp;m&nbsp;&nbsp;n&nbsp;&nbsp;n&nbsp;&nbsp;m&nbsp;&nbsp;l&nbsp;&nbsp;l&nbsp;&nbsp;k&nbsp;&nbsp;l</spanx></c>
1614 <c> 8</c>
1615 <c><spanx style="vbare">i&nbsp;&nbsp;o&nbsp;&nbsp;k&nbsp;&nbsp;o&nbsp;&nbsp;o&nbsp;&nbsp;m&nbsp;&nbsp;n&nbsp;&nbsp;m&nbsp;&nbsp;o&nbsp;&nbsp;n&nbsp;&nbsp;m&nbsp;&nbsp;m&nbsp;&nbsp;n&nbsp;&nbsp;l&nbsp;&nbsp;l&nbsp;&nbsp;l</spanx></c>
1616 <c> 9</c>
1617 <c><spanx style="vbare">k&nbsp;&nbsp;j&nbsp;&nbsp;i&nbsp;&nbsp;i&nbsp;&nbsp;i&nbsp;&nbsp;i&nbsp;&nbsp;i&nbsp;&nbsp;i&nbsp;&nbsp;i&nbsp;&nbsp;i&nbsp;&nbsp;i&nbsp;&nbsp;i&nbsp;&nbsp;i&nbsp;&nbsp;i&nbsp;&nbsp;i&nbsp;&nbsp;i</spanx></c>
1618 <c>j0</c>
1619 <c><spanx style="vbare">i&nbsp;&nbsp;j&nbsp;&nbsp;i&nbsp;&nbsp;i&nbsp;&nbsp;i&nbsp;&nbsp;i&nbsp;&nbsp;i&nbsp;&nbsp;i&nbsp;&nbsp;i&nbsp;&nbsp;i&nbsp;&nbsp;i&nbsp;&nbsp;i&nbsp;&nbsp;i&nbsp;&nbsp;i&nbsp;&nbsp;i&nbsp;&nbsp;j</spanx></c>
1620 <c>11</c>
1621 <c><spanx style="vbare">k&nbsp;&nbsp;k&nbsp;&nbsp;l&nbsp;&nbsp;m&nbsp;&nbsp;n&nbsp;&nbsp;l&nbsp;&nbsp;l&nbsp;&nbsp;l&nbsp;&nbsp;l&nbsp;&nbsp;l&nbsp;&nbsp;l&nbsp;&nbsp;l&nbsp;&nbsp;k&nbsp;&nbsp;k&nbsp;&nbsp;j&nbsp;&nbsp;l</spanx></c>
1622 <c>12</c>
1623 <c><spanx style="vbare">k&nbsp;&nbsp;k&nbsp;&nbsp;l&nbsp;&nbsp;l&nbsp;&nbsp;m&nbsp;&nbsp;l&nbsp;&nbsp;l&nbsp;&nbsp;l&nbsp;&nbsp;l&nbsp;&nbsp;l&nbsp;&nbsp;l&nbsp;&nbsp;l&nbsp;&nbsp;l&nbsp;&nbsp;k&nbsp;&nbsp;j&nbsp;&nbsp;l</spanx></c>
1624 <c>13</c>
1625 <c><spanx style="vbare">l&nbsp;&nbsp;m&nbsp;&nbsp;m&nbsp;&nbsp;m&nbsp;&nbsp;o&nbsp;&nbsp;m&nbsp;&nbsp;m&nbsp;&nbsp;n&nbsp;&nbsp;l&nbsp;&nbsp;n&nbsp;&nbsp;m&nbsp;&nbsp;m&nbsp;&nbsp;n&nbsp;&nbsp;m&nbsp;&nbsp;l&nbsp;&nbsp;m</spanx></c>
1626 <c>14</c>
1627 <c><spanx style="vbare">i&nbsp;&nbsp;o&nbsp;&nbsp;m&nbsp;&nbsp;n&nbsp;&nbsp;m&nbsp;&nbsp;p&nbsp;&nbsp;n&nbsp;&nbsp;k&nbsp;&nbsp;o&nbsp;&nbsp;n&nbsp;&nbsp;p&nbsp;&nbsp;m&nbsp;&nbsp;m&nbsp;&nbsp;l&nbsp;&nbsp;n&nbsp;&nbsp;l</spanx></c>
1628 <c>15</c>
1629 <c><spanx style="vbare">i&nbsp;&nbsp;j&nbsp;&nbsp;i&nbsp;&nbsp;j&nbsp;&nbsp;j&nbsp;&nbsp;j&nbsp;&nbsp;j&nbsp;&nbsp;j&nbsp;&nbsp;j&nbsp;&nbsp;j&nbsp;&nbsp;i&nbsp;&nbsp;i&nbsp;&nbsp;i&nbsp;&nbsp;i&nbsp;&nbsp;j&nbsp;&nbsp;i</spanx></c>
1630 <c>16</c>
1631 <c><spanx style="vbare">j&nbsp;&nbsp;o&nbsp;&nbsp;n&nbsp;&nbsp;p&nbsp;&nbsp;n&nbsp;&nbsp;m&nbsp;&nbsp;n&nbsp;&nbsp;l&nbsp;&nbsp;m&nbsp;&nbsp;n&nbsp;&nbsp;m&nbsp;&nbsp;m&nbsp;&nbsp;m&nbsp;&nbsp;l&nbsp;&nbsp;l&nbsp;&nbsp;m</spanx></c>
1632 <c>17</c>
1633 <c><spanx style="vbare">j&nbsp;&nbsp;l&nbsp;&nbsp;l&nbsp;&nbsp;m&nbsp;&nbsp;m&nbsp;&nbsp;l&nbsp;&nbsp;l&nbsp;&nbsp;n&nbsp;&nbsp;k&nbsp;&nbsp;l&nbsp;&nbsp;l&nbsp;&nbsp;n&nbsp;&nbsp;n&nbsp;&nbsp;n&nbsp;&nbsp;l&nbsp;&nbsp;m</spanx></c>
1634 <c>18</c>
1635 <c><spanx style="vbare">k&nbsp;&nbsp;l&nbsp;&nbsp;l&nbsp;&nbsp;k&nbsp;&nbsp;k&nbsp;&nbsp;k&nbsp;&nbsp;l&nbsp;&nbsp;k&nbsp;&nbsp;j&nbsp;&nbsp;k&nbsp;&nbsp;j&nbsp;&nbsp;k&nbsp;&nbsp;j&nbsp;&nbsp;j&nbsp;&nbsp;j&nbsp;&nbsp;m</spanx></c>
1636 <c>19</c>
1637 <c><spanx style="vbare">i&nbsp;&nbsp;k&nbsp;&nbsp;l&nbsp;&nbsp;n&nbsp;&nbsp;l&nbsp;&nbsp;l&nbsp;&nbsp;k&nbsp;&nbsp;k&nbsp;&nbsp;k&nbsp;&nbsp;j&nbsp;&nbsp;j&nbsp;&nbsp;i&nbsp;&nbsp;i&nbsp;&nbsp;i&nbsp;&nbsp;i&nbsp;&nbsp;i</spanx></c>
1638 <c>20</c>
1639 <c><spanx style="vbare">l&nbsp;&nbsp;m&nbsp;&nbsp;l&nbsp;&nbsp;n&nbsp;&nbsp;l&nbsp;&nbsp;l&nbsp;&nbsp;k&nbsp;&nbsp;k&nbsp;&nbsp;j&nbsp;&nbsp;j&nbsp;&nbsp;j&nbsp;&nbsp;j&nbsp;&nbsp;j&nbsp;&nbsp;k&nbsp;&nbsp;k&nbsp;&nbsp;m</spanx></c>
1640 <c>21</c>
1641 <c><spanx style="vbare">k&nbsp;&nbsp;o&nbsp;&nbsp;l&nbsp;&nbsp;p&nbsp;&nbsp;p&nbsp;&nbsp;m&nbsp;&nbsp;n&nbsp;&nbsp;m&nbsp;&nbsp;n&nbsp;&nbsp;l&nbsp;&nbsp;n&nbsp;&nbsp;l&nbsp;&nbsp;l&nbsp;&nbsp;k&nbsp;&nbsp;l&nbsp;&nbsp;l</spanx></c>
1642 <c>22</c>
1643 <c><spanx style="vbare">k&nbsp;&nbsp;l&nbsp;&nbsp;n&nbsp;&nbsp;o&nbsp;&nbsp;o&nbsp;&nbsp;l&nbsp;&nbsp;n&nbsp;&nbsp;l&nbsp;&nbsp;m&nbsp;&nbsp;m&nbsp;&nbsp;l&nbsp;&nbsp;l&nbsp;&nbsp;l&nbsp;&nbsp;l&nbsp;&nbsp;k&nbsp;&nbsp;m</spanx></c>
1644 <c>23</c>
1645 <c><spanx style="vbare">j&nbsp;&nbsp;l&nbsp;&nbsp;l&nbsp;&nbsp;m&nbsp;&nbsp;m&nbsp;&nbsp;m&nbsp;&nbsp;m&nbsp;&nbsp;l&nbsp;&nbsp;n&nbsp;&nbsp;n&nbsp;&nbsp;n&nbsp;&nbsp;l&nbsp;&nbsp;j&nbsp;&nbsp;j&nbsp;&nbsp;j&nbsp;&nbsp;j</spanx></c>
1646 <c>24</c>
1647 <c><spanx style="vbare">k&nbsp;&nbsp;n&nbsp;&nbsp;l&nbsp;&nbsp;o&nbsp;&nbsp;o&nbsp;&nbsp;m&nbsp;&nbsp;p&nbsp;&nbsp;m&nbsp;&nbsp;m&nbsp;&nbsp;n&nbsp;&nbsp;l&nbsp;&nbsp;m&nbsp;&nbsp;m&nbsp;&nbsp;l&nbsp;&nbsp;l&nbsp;&nbsp;l</spanx></c>
1648 <c>25</c>
1649 <c><spanx style="vbare">i&nbsp;&nbsp;o&nbsp;&nbsp;j&nbsp;&nbsp;j&nbsp;&nbsp;i&nbsp;&nbsp;i&nbsp;&nbsp;i&nbsp;&nbsp;i&nbsp;&nbsp;i&nbsp;&nbsp;i&nbsp;&nbsp;i&nbsp;&nbsp;i&nbsp;&nbsp;i&nbsp;&nbsp;i&nbsp;&nbsp;i&nbsp;&nbsp;i</spanx></c>
1650 <c>26</c>
1651 <c><spanx style="vbare">i&nbsp;&nbsp;o&nbsp;&nbsp;o&nbsp;&nbsp;l&nbsp;&nbsp;n&nbsp;&nbsp;k&nbsp;&nbsp;n&nbsp;&nbsp;n&nbsp;&nbsp;l&nbsp;&nbsp;m&nbsp;&nbsp;m&nbsp;&nbsp;p&nbsp;&nbsp;p&nbsp;&nbsp;m&nbsp;&nbsp;m&nbsp;&nbsp;m</spanx></c>
1652 <c>27</c>
1653 <c><spanx style="vbare">l&nbsp;&nbsp;l&nbsp;&nbsp;p&nbsp;&nbsp;l&nbsp;&nbsp;n&nbsp;&nbsp;m&nbsp;&nbsp;l&nbsp;&nbsp;l&nbsp;&nbsp;l&nbsp;&nbsp;k&nbsp;&nbsp;k&nbsp;&nbsp;l&nbsp;&nbsp;l&nbsp;&nbsp;l&nbsp;&nbsp;k&nbsp;&nbsp;l</spanx></c>
1654 <c>28</c>
1655 <c><spanx style="vbare">i&nbsp;&nbsp;i&nbsp;&nbsp;j&nbsp;&nbsp;i&nbsp;&nbsp;i&nbsp;&nbsp;i&nbsp;&nbsp;k&nbsp;&nbsp;j&nbsp;&nbsp;k&nbsp;&nbsp;j&nbsp;&nbsp;j&nbsp;&nbsp;k&nbsp;&nbsp;k&nbsp;&nbsp;k&nbsp;&nbsp;j&nbsp;&nbsp;j</spanx></c>
1656 <c>29</c>
1657 <c><spanx style="vbare">i&nbsp;&nbsp;l&nbsp;&nbsp;k&nbsp;&nbsp;n&nbsp;&nbsp;l&nbsp;&nbsp;l&nbsp;&nbsp;k&nbsp;&nbsp;l&nbsp;&nbsp;k&nbsp;&nbsp;j&nbsp;&nbsp;i&nbsp;&nbsp;i&nbsp;&nbsp;j&nbsp;&nbsp;i&nbsp;&nbsp;i&nbsp;&nbsp;j</spanx></c>
1658 <c>30</c>
1659 <c><spanx style="vbare">l&nbsp;&nbsp;n&nbsp;&nbsp;n&nbsp;&nbsp;m&nbsp;&nbsp;p&nbsp;&nbsp;n&nbsp;&nbsp;l&nbsp;&nbsp;l&nbsp;&nbsp;k&nbsp;&nbsp;l&nbsp;&nbsp;k&nbsp;&nbsp;k&nbsp;&nbsp;j&nbsp;&nbsp;i&nbsp;&nbsp;j&nbsp;&nbsp;i</spanx></c>
1660 <c>31</c>
1661 <c><spanx style="vbare">k&nbsp;&nbsp;l&nbsp;&nbsp;n&nbsp;&nbsp;l&nbsp;&nbsp;m&nbsp;&nbsp;l&nbsp;&nbsp;l&nbsp;&nbsp;l&nbsp;&nbsp;k&nbsp;&nbsp;j&nbsp;&nbsp;k&nbsp;&nbsp;o&nbsp;&nbsp;m&nbsp;&nbsp;i&nbsp;&nbsp;i&nbsp;&nbsp;i</spanx></c>
1662 </texttable>
1663
1664 <t>
1665 Decoding the second stage residual proceeds as follows.
1666 For each coefficient, the decoder reads a symbol using the PDF corresponding to
1667  I1 from either <xref target="silk_nlsf_nbmb_stage2_cb_sel"/> or
1668  <xref target="silk_nlsf_wb_stage2_cb_sel"/>, and subtracts 4 from the result
1669  to given an index in the range -4 to 4, inclusive.
1670 If the index is either -4 or 4, it reads a second symbol using the PDF in
1671  <xref target="silk_nlsf_ext_pdf"/>, and adds the value of this second symbol
1672  to the index, using the same sign.
1673 This gives the index, I2[k], a total range of -10 to 10, inclusive.
1674 </t>
1675
1676 <texttable anchor="silk_nlsf_ext_pdf"
1677  title="PDF for Normalized LSF Index Extension Decoding">
1678 <ttcol align="left">PDF</ttcol>
1679 <c>{156, 60, 24,  9,  4,  2,  1}/256</c>
1680 </texttable>
1681
1682 <t>
1683 The decoded indices from both stages are translated back into normalized LSF
1684  coefficients in silk_NLSF_decode() (silk_NLSF_decode.c).
1685 The stage-2 indices represent residuals after both the first stage of the VQ
1686  and a separate backwards-prediction step.
1687 The backwards prediction process in the encoder subtracts a prediction from
1688  each residual formed by a multiple of the coefficient that follows it.
1689 The decoder must undo this process.
1690 <xref target="silk_nlsf_pred_weights"/> contains lists of prediction weights
1691  for each coefficient.
1692 There are two lists for NB and MB, and another two lists for WB, giving two
1693  possible prediction weights for each coefficient.
1694 </t>
1695
1696 <texttable anchor="silk_nlsf_pred_weights"
1697  title="Prediction Weights for Normalized LSF Decoding">
1698 <ttcol align="left">Coefficient</ttcol>
1699 <ttcol align="right">A</ttcol>
1700 <ttcol align="right">B</ttcol>
1701 <ttcol align="right">C</ttcol>
1702 <ttcol align="right">D</ttcol>
1703  <c>0</c> <c>179</c> <c>116</c> <c>175</c>  <c>68</c>
1704  <c>1</c> <c>138</c>  <c>67</c> <c>148</c>  <c>62</c>
1705  <c>2</c> <c>140</c>  <c>82</c> <c>160</c>  <c>66</c>
1706  <c>3</c> <c>148</c>  <c>59</c> <c>176</c>  <c>60</c>
1707  <c>4</c> <c>151</c>  <c>92</c> <c>178</c>  <c>72</c>
1708  <c>5</c> <c>149</c>  <c>72</c> <c>173</c> <c>117</c>
1709  <c>6</c> <c>153</c> <c>100</c> <c>174</c>  <c>85</c>
1710  <c>7</c> <c>151</c>  <c>89</c> <c>164</c>  <c>90</c>
1711  <c>8</c> <c>163</c>  <c>92</c> <c>177</c> <c>118</c>
1712  <c>9</c> <c/>        <c/>      <c>174</c> <c>136</c>
1713 <c>10</c> <c/>        <c/>      <c>196</c> <c>151</c>
1714 <c>11</c> <c/>        <c/>      <c>182</c> <c>142</c>
1715 <c>12</c> <c/>        <c/>      <c>198</c> <c>160</c>
1716 <c>13</c> <c/>        <c/>      <c>192</c> <c>142</c>
1717 <c>14</c> <c/>        <c/>      <c>182</c> <c>155</c>
1718 </texttable>
1719
1720 <t>
1721 The prediction is undone using the procedure implemented in
1722  silk_NLSF_residual_dequant() (silk_NLSF_decode.c), which is as follows.
1723 Each coefficient selects its prediction weight from one of the two lists based
1724  on the stage-1 index, I1.
1725 <xref target="silk_nlsf_nbmb_weight_sel"/> gives the selections for each
1726  coefficient for NB and MB, and <xref target="silk_nlsf_wb_weight_sel"/> gives
1727  the selections for WB.
1728 Let d_LPC be the order of the codebook, i.e., 10 for NB and MB, and 16 for WB,
1729  and let pred_Q8[k] be the weight for the <spanx style="emph">k</spanx>th
1730  coefficient selected by this process for
1731  0&nbsp;&lt;=&nbsp;k&nbsp;&lt;&nbsp;d_LPC-1.
1732 Then, the stage-2 residual for each coefficient is computed via
1733 <figure align="center">
1734 <artwork align="center"><![CDATA[
1735   res_Q10[k] = (k+1 < d_LPC ? (res_Q10[k+1]*pred_Q8[k])>>8 : 0)
1736                + ((((I2[k]<<10) + sign(I2[k])*102)*qstep)>>16) ,
1737 ]]></artwork>
1738 </figure>
1739  where qstep is the Q16 quantization step size, which is 11796 for NB and MB
1740  and 9830 for WB (representing step sizes of approximately 0.18 and 0.15,
1741  respectively).
1742 </t>
1743
1744 <texttable anchor="silk_nlsf_nbmb_weight_sel"
1745  title="Prediction Weight Selection for NB/MB Normalized LSF Decoding">
1746 <ttcol>I1</ttcol>
1747 <ttcol>Coefficient</ttcol>
1748 <c/>
1749 <c><spanx style="vbare">0&nbsp;1&nbsp;2&nbsp;3&nbsp;4&nbsp;5&nbsp;6&nbsp;7&nbsp;8</spanx></c>
1750 <c> 0</c>
1751 <c><spanx style="vbare">A&nbsp;B&nbsp;A&nbsp;A&nbsp;A&nbsp;A&nbsp;A&nbsp;A&nbsp;A</spanx></c>
1752 <c> 1</c>
1753 <c><spanx style="vbare">B&nbsp;A&nbsp;A&nbsp;A&nbsp;A&nbsp;A&nbsp;A&nbsp;A&nbsp;A</spanx></c>
1754 <c> 2</c>
1755 <c><spanx style="vbare">A&nbsp;A&nbsp;A&nbsp;A&nbsp;A&nbsp;A&nbsp;A&nbsp;A&nbsp;A</spanx></c>
1756 <c> 3</c>
1757 <c><spanx style="vbare">B&nbsp;B&nbsp;B&nbsp;A&nbsp;A&nbsp;A&nbsp;A&nbsp;B&nbsp;A</spanx></c>
1758 <c> 4</c>
1759 <c><spanx style="vbare">A&nbsp;B&nbsp;A&nbsp;A&nbsp;A&nbsp;A&nbsp;A&nbsp;A&nbsp;A</spanx></c>
1760 <c> 5</c>
1761 <c><spanx style="vbare">A&nbsp;B&nbsp;A&nbsp;A&nbsp;A&nbsp;A&nbsp;A&nbsp;A&nbsp;A</spanx></c>
1762 <c> 6</c>
1763 <c><spanx style="vbare">B&nbsp;A&nbsp;B&nbsp;B&nbsp;A&nbsp;A&nbsp;A&nbsp;B&nbsp;A</spanx></c>
1764 <c> 7</c>
1765 <c><spanx style="vbare">A&nbsp;B&nbsp;B&nbsp;A&nbsp;A&nbsp;B&nbsp;B&nbsp;A&nbsp;A</spanx></c>
1766 <c> 8</c>
1767 <c><spanx style="vbare">A&nbsp;A&nbsp;B&nbsp;B&nbsp;A&nbsp;B&nbsp;A&nbsp;B&nbsp;B</spanx></c>
1768 <c> 9</c>
1769 <c><spanx style="vbare">A&nbsp;A&nbsp;B&nbsp;B&nbsp;A&nbsp;A&nbsp;B&nbsp;B&nbsp;B</spanx></c>
1770 <c>10</c>
1771 <c><spanx style="vbare">A&nbsp;A&nbsp;A&nbsp;A&nbsp;A&nbsp;A&nbsp;A&nbsp;A&nbsp;A</spanx></c>
1772 <c>11</c>
1773 <c><spanx style="vbare">A&nbsp;B&nbsp;A&nbsp;B&nbsp;B&nbsp;B&nbsp;B&nbsp;B&nbsp;A</spanx></c>
1774 <c>12</c>
1775 <c><spanx style="vbare">A&nbsp;B&nbsp;A&nbsp;B&nbsp;B&nbsp;B&nbsp;B&nbsp;B&nbsp;A</spanx></c>
1776 <c>13</c>
1777 <c><spanx style="vbare">A&nbsp;B&nbsp;B&nbsp;B&nbsp;B&nbsp;B&nbsp;B&nbsp;B&nbsp;A</spanx></c>
1778 <c>14</c>
1779 <c><spanx style="vbare">B&nbsp;A&nbsp;B&nbsp;B&nbsp;A&nbsp;B&nbsp;B&nbsp;B&nbsp;B</spanx></c>
1780 <c>15</c>
1781 <c><spanx style="vbare">A&nbsp;B&nbsp;B&nbsp;B&nbsp;B&nbsp;B&nbsp;A&nbsp;B&nbsp;A</spanx></c>
1782 <c>16</c>
1783 <c><spanx style="vbare">A&nbsp;A&nbsp;B&nbsp;B&nbsp;A&nbsp;B&nbsp;A&nbsp;B&nbsp;A</spanx></c>
1784 <c>17</c>
1785 <c><spanx style="vbare">A&nbsp;A&nbsp;B&nbsp;B&nbsp;B&nbsp;A&nbsp;B&nbsp;B&nbsp;B</spanx></c>
1786 <c>18</c>
1787 <c><spanx style="vbare">A&nbsp;B&nbsp;B&nbsp;A&nbsp;A&nbsp;B&nbsp;B&nbsp;B&nbsp;A</spanx></c>
1788 <c>19</c>
1789 <c><spanx style="vbare">A&nbsp;A&nbsp;A&nbsp;B&nbsp;B&nbsp;B&nbsp;A&nbsp;B&nbsp;A</spanx></c>
1790 <c>20</c>
1791 <c><spanx style="vbare">A&nbsp;B&nbsp;B&nbsp;A&nbsp;A&nbsp;B&nbsp;A&nbsp;B&nbsp;A</spanx></c>
1792 <c>21</c>
1793 <c><spanx style="vbare">A&nbsp;B&nbsp;B&nbsp;A&nbsp;A&nbsp;A&nbsp;B&nbsp;B&nbsp;A</spanx></c>
1794 <c>22</c>
1795 <c><spanx style="vbare">A&nbsp;A&nbsp;A&nbsp;A&nbsp;A&nbsp;B&nbsp;B&nbsp;B&nbsp;B</spanx></c>
1796 <c>23</c>
1797 <c><spanx style="vbare">A&nbsp;A&nbsp;B&nbsp;B&nbsp;A&nbsp;A&nbsp;A&nbsp;B&nbsp;B</spanx></c>
1798 <c>24</c>
1799 <c><spanx style="vbare">A&nbsp;A&nbsp;A&nbsp;B&nbsp;A&nbsp;B&nbsp;B&nbsp;B&nbsp;B</spanx></c>
1800 <c>25</c>
1801 <c><spanx style="vbare">A&nbsp;B&nbsp;B&nbsp;B&nbsp;B&nbsp;B&nbsp;B&nbsp;B&nbsp;A</spanx></c>
1802 <c>26</c>
1803 <c><spanx style="vbare">A&nbsp;A&nbsp;A&nbsp;A&nbsp;A&nbsp;A&nbsp;A&nbsp;A&nbsp;A</spanx></c>
1804 <c>27</c>
1805 <c><spanx style="vbare">A&nbsp;A&nbsp;A&nbsp;A&nbsp;A&nbsp;A&nbsp;A&nbsp;A&nbsp;A</spanx></c>
1806 <c>28</c>
1807 <c><spanx style="vbare">A&nbsp;A&nbsp;B&nbsp;A&nbsp;B&nbsp;B&nbsp;A&nbsp;B&nbsp;A</spanx></c>
1808 <c>29</c>
1809 <c><spanx style="vbare">A&nbsp;A&nbsp;A&nbsp;B&nbsp;A&nbsp;A&nbsp;A&nbsp;A&nbsp;A</spanx></c>
1810 <c>30</c>
1811 <c><spanx style="vbare">A&nbsp;A&nbsp;A&nbsp;B&nbsp;B&nbsp;A&nbsp;B&nbsp;A&nbsp;B</spanx></c>
1812 <c>31</c>
1813 <c><spanx style="vbare">B&nbsp;A&nbsp;B&nbsp;B&nbsp;A&nbsp;B&nbsp;B&nbsp;B&nbsp;B</spanx></c>
1814 </texttable>
1815
1816 <texttable anchor="silk_nlsf_wb_weight_sel"
1817  title="Prediction Weight Selection for WB Normalized LSF Decoding">
1818 <ttcol>I1</ttcol>
1819 <ttcol>Coefficient</ttcol>
1820 <c/>
1821 <c><spanx style="vbare">0&nbsp;&nbsp;1&nbsp;&nbsp;2&nbsp;&nbsp;3&nbsp;&nbsp;4&nbsp;&nbsp;5&nbsp;&nbsp;6&nbsp;&nbsp;7&nbsp;&nbsp;8&nbsp;&nbsp;9&nbsp;10&nbsp;11&nbsp;12&nbsp;13&nbsp;14</spanx></c>
1822 <c> 0</c>
1823 <c><spanx style="vbare">C&nbsp;&nbsp;C&nbsp;&nbsp;C&nbsp;&nbsp;C&nbsp;&nbsp;C&nbsp;&nbsp;C&nbsp;&nbsp;C&nbsp;&nbsp;C&nbsp;&nbsp;C&nbsp;&nbsp;C&nbsp;&nbsp;C&nbsp;&nbsp;C&nbsp;&nbsp;C&nbsp;&nbsp;C&nbsp;&nbsp;D</spanx></c>
1824 <c> 1</c>
1825 <c><spanx style="vbare">C&nbsp;&nbsp;C&nbsp;&nbsp;C&nbsp;&nbsp;C&nbsp;&nbsp;C&nbsp;&nbsp;C&nbsp;&nbsp;C&nbsp;&nbsp;C&nbsp;&nbsp;C&nbsp;&nbsp;C&nbsp;&nbsp;C&nbsp;&nbsp;C&nbsp;&nbsp;C&nbsp;&nbsp;C&nbsp;&nbsp;C</spanx></c>
1826 <c> 2</c>
1827 <c><spanx style="vbare">C&nbsp;&nbsp;C&nbsp;&nbsp;D&nbsp;&nbsp;C&nbsp;&nbsp;C&nbsp;&nbsp;D&nbsp;&nbsp;D&nbsp;&nbsp;D&nbsp;&nbsp;C&nbsp;&nbsp;D&nbsp;&nbsp;D&nbsp;&nbsp;D&nbsp;&nbsp;D&nbsp;&nbsp;C&nbsp;&nbsp;C</spanx></c>
1828 <c> 3</c>
1829 <c><spanx style="vbare">C&nbsp;&nbsp;C&nbsp;&nbsp;C&nbsp;&nbsp;C&nbsp;&nbsp;C&nbsp;&nbsp;C&nbsp;&nbsp;C&nbsp;&nbsp;C&nbsp;&nbsp;C&nbsp;&nbsp;C&nbsp;&nbsp;C&nbsp;&nbsp;C&nbsp;&nbsp;D&nbsp;&nbsp;C&nbsp;&nbsp;C</spanx></c>
1830 <c> 4</c>
1831 <c><spanx style="vbare">C&nbsp;&nbsp;D&nbsp;&nbsp;D&nbsp;&nbsp;C&nbsp;&nbsp;D&nbsp;&nbsp;C&nbsp;&nbsp;D&nbsp;&nbsp;D&nbsp;&nbsp;C&nbsp;&nbsp;D&nbsp;&nbsp;D&nbsp;&nbsp;D&nbsp;&nbsp;D&nbsp;&nbsp;D&nbsp;&nbsp;C</spanx></c>
1832 <c> 5</c>
1833 <c><spanx style="vbare">C&nbsp;&nbsp;D&nbsp;&nbsp;C&nbsp;&nbsp;C&nbsp;&nbsp;C&nbsp;&nbsp;C&nbsp;&nbsp;C&nbsp;&nbsp;C&nbsp;&nbsp;C&nbsp;&nbsp;C&nbsp;&nbsp;C&nbsp;&nbsp;C&nbsp;&nbsp;C&nbsp;&nbsp;C&nbsp;&nbsp;C</spanx></c>
1834 <c> 6</c>
1835 <c><spanx style="vbare">D&nbsp;&nbsp;C&nbsp;&nbsp;C&nbsp;&nbsp;C&nbsp;&nbsp;C&nbsp;&nbsp;C&nbsp;&nbsp;C&nbsp;&nbsp;C&nbsp;&nbsp;C&nbsp;&nbsp;C&nbsp;&nbsp;C&nbsp;&nbsp;D&nbsp;&nbsp;C&nbsp;&nbsp;D&nbsp;&nbsp;C</spanx></c>
1836 <c> 7</c>
1837 <c><spanx style="vbare">C&nbsp;&nbsp;D&nbsp;&nbsp;D&nbsp;&nbsp;C&nbsp;&nbsp;C&nbsp;&nbsp;C&nbsp;&nbsp;D&nbsp;&nbsp;C&nbsp;&nbsp;D&nbsp;&nbsp;D&nbsp;&nbsp;D&nbsp;&nbsp;C&nbsp;&nbsp;D&nbsp;&nbsp;C&nbsp;&nbsp;D</spanx></c>
1838 <c> 8</c>
1839 <c><spanx style="vbare">C&nbsp;&nbsp;D&nbsp;&nbsp;C&nbsp;&nbsp;D&nbsp;&nbsp;D&nbsp;&nbsp;C&nbsp;&nbsp;D&nbsp;&nbsp;C&nbsp;&nbsp;D&nbsp;&nbsp;C&nbsp;&nbsp;D&nbsp;&nbsp;D&nbsp;&nbsp;D&nbsp;&nbsp;D&nbsp;&nbsp;D</spanx></c>
1840 <c> 9</c>
1841 <c><spanx style="vbare">C&nbsp;&nbsp;C&nbsp;&nbsp;C&nbsp;&nbsp;C&nbsp;&nbsp;C&nbsp;&nbsp;C&nbsp;&nbsp;C&nbsp;&nbsp;C&nbsp;&nbsp;C&nbsp;&nbsp;C&nbsp;&nbsp;C&nbsp;&nbsp;C&nbsp;&nbsp;C&nbsp;&nbsp;C&nbsp;&nbsp;D</spanx></c>
1842 <c>10</c>
1843 <c><spanx style="vbare">C&nbsp;&nbsp;D&nbsp;&nbsp;C&nbsp;&nbsp;C&nbsp;&nbsp;C&nbsp;&nbsp;C&nbsp;&nbsp;C&nbsp;&nbsp;C&nbsp;&nbsp;C&nbsp;&nbsp;C&nbsp;&nbsp;C&nbsp;&nbsp;C&nbsp;&nbsp;C&nbsp;&nbsp;C&nbsp;&nbsp;C</spanx></c>
1844 <c>11</c>
1845 <c><spanx style="vbare">C&nbsp;&nbsp;C&nbsp;&nbsp;D&nbsp;&nbsp;C&nbsp;&nbsp;D&nbsp;&nbsp;D&nbsp;&nbsp;D&nbsp;&nbsp;D&nbsp;&nbsp;D&nbsp;&nbsp;D&nbsp;&nbsp;D&nbsp;&nbsp;C&nbsp;&nbsp;D&nbsp;&nbsp;C&nbsp;&nbsp;C</spanx></c>
1846 <c>12</c>
1847 <c><spanx style="vbare">C&nbsp;&nbsp;C&nbsp;&nbsp;D&nbsp;&nbsp;C&nbsp;&nbsp;C&nbsp;&nbsp;D&nbsp;&nbsp;C&nbsp;&nbsp;D&nbsp;&nbsp;C&nbsp;&nbsp;D&nbsp;&nbsp;C&nbsp;&nbsp;C&nbsp;&nbsp;D&nbsp;&nbsp;C&nbsp;&nbsp;C</spanx></c>
1848 <c>13</c>
1849 <c><spanx style="vbare">C&nbsp;&nbsp;C&nbsp;&nbsp;C&nbsp;&nbsp;C&nbsp;&nbsp;D&nbsp;&nbsp;D&nbsp;&nbsp;C&nbsp;&nbsp;D&nbsp;&nbsp;C&nbsp;&nbsp;D&nbsp;&nbsp;D&nbsp;&nbsp;D&nbsp;&nbsp;D&nbsp;&nbsp;C&nbsp;&nbsp;C</spanx></c>
1850 <c>14</c>
1851 <c><spanx style="vbare">C&nbsp;&nbsp;D&nbsp;&nbsp;C&nbsp;&nbsp;C&nbsp;&nbsp;C&nbsp;&nbsp;D&nbsp;&nbsp;D&nbsp;&nbsp;C&nbsp;&nbsp;D&nbsp;&nbsp;D&nbsp;&nbsp;D&nbsp;&nbsp;C&nbsp;&nbsp;D&nbsp;&nbsp;D&nbsp;&nbsp;D</spanx></c>
1852 <c>15</c>
1853 <c><spanx style="vbare">C&nbsp;&nbsp;C&nbsp;&nbsp;D&nbsp;&nbsp;D&nbsp;&nbsp;C&nbsp;&nbsp;C&nbsp;&nbsp;C&nbsp;&nbsp;C&nbsp;&nbsp;C&nbsp;&nbsp;C&nbsp;&nbsp;C&nbsp;&nbsp;C&nbsp;&nbsp;D&nbsp;&nbsp;D&nbsp;&nbsp;C</spanx></c>
1854 <c>16</c>
1855 <c><spanx style="vbare">C&nbsp;&nbsp;D&nbsp;&nbsp;D&nbsp;&nbsp;C&nbsp;&nbsp;D&nbsp;&nbsp;C&nbsp;&nbsp;D&nbsp;&nbsp;D&nbsp;&nbsp;D&nbsp;&nbsp;D&nbsp;&nbsp;D&nbsp;&nbsp;C&nbsp;&nbsp;D&nbsp;&nbsp;C&nbsp;&nbsp;C</spanx></c>
1856 <c>17</c>
1857 <c><spanx style="vbare">C&nbsp;&nbsp;C&nbsp;&nbsp;D&nbsp;&nbsp;C&nbsp;&nbsp;C&nbsp;&nbsp;C&nbsp;&nbsp;C&nbsp;&nbsp;D&nbsp;&nbsp;C&nbsp;&nbsp;C&nbsp;&nbsp;D&nbsp;&nbsp;D&nbsp;&nbsp;D&nbsp;&nbsp;C&nbsp;&nbsp;C</spanx></c>
1858 <c>18</c>
1859 <c><spanx style="vbare">C&nbsp;&nbsp;C&nbsp;&nbsp;C&nbsp;&nbsp;C&nbsp;&nbsp;C&nbsp;&nbsp;C&nbsp;&nbsp;C&nbsp;&nbsp;C&nbsp;&nbsp;C&nbsp;&nbsp;C&nbsp;&nbsp;C&nbsp;&nbsp;C&nbsp;&nbsp;C&nbsp;&nbsp;C&nbsp;&nbsp;D</spanx></c>
1860 <c>19</c>
1861 <c><spanx style="vbare">C&nbsp;&nbsp;C&nbsp;&nbsp;C&nbsp;&nbsp;C&nbsp;&nbsp;C&nbsp;&nbsp;C&nbsp;&nbsp;C&nbsp;&nbsp;C&nbsp;&nbsp;C&nbsp;&nbsp;C&nbsp;&nbsp;C&nbsp;&nbsp;C&nbsp;&nbsp;D&nbsp;&nbsp;C&nbsp;&nbsp;C</spanx></c>
1862 <c>20</c>
1863 <c><spanx style="vbare">C&nbsp;&nbsp;C&nbsp;&nbsp;C&nbsp;&nbsp;C&nbsp;&nbsp;C&nbsp;&nbsp;C&nbsp;&nbsp;C&nbsp;&nbsp;C&nbsp;&nbsp;C&nbsp;&nbsp;C&nbsp;&nbsp;C&nbsp;&nbsp;C&nbsp;&nbsp;C&nbsp;&nbsp;C&nbsp;&nbsp;C</spanx></c>
1864 <c>21</c>
1865 <c><spanx style="vbare">C&nbsp;&nbsp;D&nbsp;&nbsp;C&nbsp;&nbsp;D&nbsp;&nbsp;C&nbsp;&nbsp;D&nbsp;&nbsp;D&nbsp;&nbsp;C&nbsp;&nbsp;D&nbsp;&nbsp;C&nbsp;&nbsp;D&nbsp;&nbsp;C&nbsp;&nbsp;D&nbsp;&nbsp;D&nbsp;&nbsp;C</spanx></c>
1866 <c>22</c>
1867 <c><spanx style="vbare">C&nbsp;&nbsp;C&nbsp;&nbsp;D&nbsp;&nbsp;D&nbsp;&nbsp;D&nbsp;&nbsp;D&nbsp;&nbsp;C&nbsp;&nbsp;D&nbsp;&nbsp;D&nbsp;&nbsp;C&nbsp;&nbsp;C&nbsp;&nbsp;D&nbsp;&nbsp;D&nbsp;&nbsp;C&nbsp;&nbsp;C</spanx></c>
1868 <c>23</c>
1869 <c><spanx style="vbare">C&nbsp;&nbsp;D&nbsp;&nbsp;D&nbsp;&nbsp;C&nbsp;&nbsp;D&nbsp;&nbsp;C&nbsp;&nbsp;D&nbsp;&nbsp;C&nbsp;&nbsp;D&nbsp;&nbsp;C&nbsp;&nbsp;C&nbsp;&nbsp;C&nbsp;&nbsp;C&nbsp;&nbsp;D&nbsp;&nbsp;C</spanx></c>
1870 <c>24</c>
1871 <c><spanx style="vbare">C&nbsp;&nbsp;C&nbsp;&nbsp;C&nbsp;&nbsp;D&nbsp;&nbsp;D&nbsp;&nbsp;C&nbsp;&nbsp;D&nbsp;&nbsp;C&nbsp;&nbsp;D&nbsp;&nbsp;D&nbsp;&nbsp;D&nbsp;&nbsp;D&nbsp;&nbsp;D&nbsp;&nbsp;D&nbsp;&nbsp;D</spanx></c>
1872 <c>25</c>
1873 <c><spanx style="vbare">C&nbsp;&nbsp;C&nbsp;&nbsp;C&nbsp;&nbsp;C&nbsp;&nbsp;C&nbsp;&nbsp;C&nbsp;&nbsp;C&nbsp;&nbsp;C&nbsp;&nbsp;C&nbsp;&nbsp;C&nbsp;&nbsp;C&nbsp;&nbsp;C&nbsp;&nbsp;C&nbsp;&nbsp;C&nbsp;&nbsp;D</spanx></c>
1874 <c>26</c>
1875 <c><spanx style="vbare">C&nbsp;&nbsp;D&nbsp;&nbsp;D&nbsp;&nbsp;C&nbsp;&nbsp;C&nbsp;&nbsp;C&nbsp;&nbsp;D&nbsp;&nbsp;D&nbsp;&nbsp;C&nbsp;&nbsp;C&nbsp;&nbsp;D&nbsp;&nbsp;D&nbsp;&nbsp;D&nbsp;&nbsp;D&nbsp;&nbsp;D</spanx></c>
1876 <c>27</c>
1877 <c><spanx style="vbare">C&nbsp;&nbsp;C&nbsp;&nbsp;C&nbsp;&nbsp;C&nbsp;&nbsp;C&nbsp;&nbsp;D&nbsp;&nbsp;C&nbsp;&nbsp;D&nbsp;&nbsp;D&nbsp;&nbsp;D&nbsp;&nbsp;D&nbsp;&nbsp;C&nbsp;&nbsp;D&nbsp;&nbsp;D&nbsp;&nbsp;D</spanx></c>
1878 <c>28</c>
1879 <c><spanx style="vbare">C&nbsp;&nbsp;C&nbsp;&nbsp;C&nbsp;&nbsp;C&nbsp;&nbsp;C&nbsp;&nbsp;C&nbsp;&nbsp;C&nbsp;&nbsp;C&nbsp;&nbsp;C&nbsp;&nbsp;C&nbsp;&nbsp;C&nbsp;&nbsp;C&nbsp;&nbsp;C&nbsp;&nbsp;C&nbsp;&nbsp;D</spanx></c>
1880 <c>29</c>
1881 <c><spanx style="vbare">C&nbsp;&nbsp;C&nbsp;&nbsp;C&nbsp;&nbsp;C&nbsp;&nbsp;C&nbsp;&nbsp;C&nbsp;&nbsp;C&nbsp;&nbsp;C&nbsp;&nbsp;C&nbsp;&nbsp;C&nbsp;&nbsp;C&nbsp;&nbsp;C&nbsp;&nbsp;C&nbsp;&nbsp;C&nbsp;&nbsp;D</spanx></c>
1882 <c>30</c>
1883 <c><spanx style="vbare">D&nbsp;&nbsp;C&nbsp;&nbsp;C&nbsp;&nbsp;C&nbsp;&nbsp;C&nbsp;&nbsp;C&nbsp;&nbsp;C&nbsp;&nbsp;C&nbsp;&nbsp;C&nbsp;&nbsp;C&nbsp;&nbsp;C&nbsp;&nbsp;D&nbsp;&nbsp;C&nbsp;&nbsp;C&nbsp;&nbsp;C</spanx></c>
1884 <c>31</c>
1885 <c><spanx style="vbare">C&nbsp;&nbsp;C&nbsp;&nbsp;D&nbsp;&nbsp;C&nbsp;&nbsp;C&nbsp;&nbsp;D&nbsp;&nbsp;D&nbsp;&nbsp;D&nbsp;&nbsp;C&nbsp;&nbsp;C&nbsp;&nbsp;D&nbsp;&nbsp;C&nbsp;&nbsp;C&nbsp;&nbsp;D&nbsp;&nbsp;C</spanx></c>
1886 </texttable>
1887
1888 <t>
1889 The spectral distortion introduced by the quantization of each LSF coefficient
1890  varies, so the stage-2 residual is weighted accordingly, using the
1891  low-complexity weighting function proposed in <xref target="laroia-icassp"/>.
1892 The weights are derived directly from the stage-1 codebook vector.
1893 Let cb1_Q8[k] be the <spanx style="emph">k</spanx>th entry of the stage-1
1894  codebook vector from <xref target="silk_nlsf_nbmb_codebook"/> or
1895  <xref target="silk_nlsf_wb_codebook"/>.
1896 Then for 0&nbsp;&lt;=&nbsp;k&nbsp;&lt;&nbsp;d_LPC the following expression
1897  computes the square of the weight as a Q18 value:
1898 <figure align="center">
1899 <artwork align="center">
1900 <![CDATA[
1901 w2_Q18[k] = (1024/(cb1_Q8[k] - cb1_Q8[k-1])
1902              + 1024/(cb1_Q8[k+1] - cb1_Q8[k])) << 16 ,
1903 ]]>
1904 </artwork>
1905 </figure>
1906  where cb1_Q8[-1]&nbsp;=&nbsp;0 and cb1_Q8[d_LPC]&nbsp;=&nbsp;256, and the
1907  division is exact integer division.
1908 This is reduced to an unsquared, Q9 value using the following square-root
1909  approximation:
1910 <figure align="center">
1911 <artwork align="center"><![CDATA[
1912 i = ilog(w2_Q18[k])
1913 f = (w2_Q18[k]>>(i-8)) & 127
1914 y = ((i&1) ? 32768 : 46214) >> ((32-i)>>1)
1915 w_Q9[k] = y + ((213*f*y)>>16)
1916 ]]></artwork>
1917 </figure>
1918 The cb1_Q8[] vector completely determines these weights, and they may be
1919  tabulated and stored as 13-bit unsigned values (with a range of 1819 to 5227)
1920  to avoid computing them when decoding.
1921 The reference implementation computes them on the fly in
1922  silk_NLSF_VQ_weights_laroia() (silk_NLSF_VQ_weights_laroia.c) and its
1923  caller, to reduce the amount of ROM required.
1924 </t>
1925
1926 <texttable anchor="silk_nlsf_nbmb_codebook"
1927            title="Codebook Vectors for NB/MB Normalized LSF Stage 1 Decoding">
1928 <ttcol>I1</ttcol>
1929 <ttcol>Codebook</ttcol>
1930 <c/>
1931 <c><spanx style="vbare">&nbsp;0&nbsp;&nbsp;&nbsp;1&nbsp;&nbsp;&nbsp;2&nbsp;&nbsp;&nbsp;3&nbsp;&nbsp;&nbsp;4&nbsp;&nbsp;&nbsp;5&nbsp;&nbsp;&nbsp;6&nbsp;&nbsp;&nbsp;7&nbsp;&nbsp;&nbsp;8&nbsp;&nbsp;&nbsp;9</spanx></c>
1932 <c>0</c>
1933 <c><spanx style="vbare">12&nbsp;&nbsp;35&nbsp;&nbsp;60&nbsp;&nbsp;83&nbsp;108&nbsp;132&nbsp;157&nbsp;180&nbsp;206&nbsp;228</spanx></c>
1934 <c>1</c>
1935 <c><spanx style="vbare">15&nbsp;&nbsp;32&nbsp;&nbsp;55&nbsp;&nbsp;77&nbsp;101&nbsp;125&nbsp;151&nbsp;175&nbsp;201&nbsp;225</spanx></c>
1936 <c>2</c>
1937 <c><spanx style="vbare">19&nbsp;&nbsp;42&nbsp;&nbsp;66&nbsp;&nbsp;89&nbsp;114&nbsp;137&nbsp;162&nbsp;184&nbsp;209&nbsp;230</spanx></c>
1938 <c>3</c>
1939 <c><spanx style="vbare">12&nbsp;&nbsp;25&nbsp;&nbsp;50&nbsp;&nbsp;72&nbsp;&nbsp;97&nbsp;120&nbsp;147&nbsp;172&nbsp;200&nbsp;223</spanx></c>
1940 <c>4</c>
1941 <c><spanx style="vbare">26&nbsp;&nbsp;44&nbsp;&nbsp;69&nbsp;&nbsp;90&nbsp;114&nbsp;135&nbsp;159&nbsp;180&nbsp;205&nbsp;225</spanx></c>
1942 <c>5</c>
1943 <c><spanx style="vbare">13&nbsp;&nbsp;22&nbsp;&nbsp;53&nbsp;&nbsp;80&nbsp;106&nbsp;130&nbsp;156&nbsp;180&nbsp;205&nbsp;228</spanx></c>
1944 <c>6</c>
1945 <c><spanx style="vbare">15&nbsp;&nbsp;25&nbsp;&nbsp;44&nbsp;&nbsp;64&nbsp;&nbsp;90&nbsp;115&nbsp;142&nbsp;168&nbsp;196&nbsp;222</spanx></c>
1946 <c>7</c>
1947 <c><spanx style="vbare">19&nbsp;&nbsp;24&nbsp;&nbsp;62&nbsp;&nbsp;82&nbsp;100&nbsp;120&nbsp;145&nbsp;168&nbsp;190&nbsp;214</spanx></c>
1948 <c>8</c>
1949 <c><spanx style="vbare">22&nbsp;&nbsp;31&nbsp;&nbsp;50&nbsp;&nbsp;79&nbsp;103&nbsp;120&nbsp;151&nbsp;170&nbsp;203&nbsp;227</spanx></c>
1950 <c>9</c>
1951 <c><spanx style="vbare">21&nbsp;&nbsp;29&nbsp;&nbsp;45&nbsp;&nbsp;65&nbsp;106&nbsp;124&nbsp;150&nbsp;171&nbsp;196&nbsp;224</spanx></c>
1952 <c>10</c>
1953 <c><spanx style="vbare">30&nbsp;&nbsp;49&nbsp;&nbsp;75&nbsp;&nbsp;97&nbsp;121&nbsp;142&nbsp;165&nbsp;186&nbsp;209&nbsp;229</spanx></c>
1954 <c>11</c>
1955 <c><spanx style="vbare">19&nbsp;&nbsp;25&nbsp;&nbsp;52&nbsp;&nbsp;70&nbsp;&nbsp;93&nbsp;116&nbsp;143&nbsp;166&nbsp;192&nbsp;219</spanx></c>
1956 <c>12</c>
1957 <c><spanx style="vbare">26&nbsp;&nbsp;34&nbsp;&nbsp;62&nbsp;&nbsp;75&nbsp;&nbsp;97&nbsp;118&nbsp;145&nbsp;167&nbsp;194&nbsp;217</spanx></c>
1958 <c>13</c>
1959 <c><spanx style="vbare">25&nbsp;&nbsp;33&nbsp;&nbsp;56&nbsp;&nbsp;70&nbsp;&nbsp;91&nbsp;113&nbsp;143&nbsp;165&nbsp;196&nbsp;223</spanx></c>
1960 <c>14</c>
1961 <c><spanx style="vbare">21&nbsp;&nbsp;34&nbsp;&nbsp;51&nbsp;&nbsp;72&nbsp;&nbsp;97&nbsp;117&nbsp;145&nbsp;171&nbsp;196&nbsp;222</spanx></c>
1962 <c>15</c>
1963 <c><spanx style="vbare">20&nbsp;&nbsp;29&nbsp;&nbsp;50&nbsp;&nbsp;67&nbsp;&nbsp;90&nbsp;117&nbsp;144&nbsp;168&nbsp;197&nbsp;221</spanx></c>
1964 <c>16</c>
1965 <c><spanx style="vbare">22&nbsp;&nbsp;31&nbsp;&nbsp;48&nbsp;&nbsp;66&nbsp;&nbsp;95&nbsp;117&nbsp;146&nbsp;168&nbsp;196&nbsp;222</spanx></c>
1966 <c>17</c>
1967 <c><spanx style="vbare">24&nbsp;&nbsp;33&nbsp;&nbsp;51&nbsp;&nbsp;77&nbsp;116&nbsp;134&nbsp;158&nbsp;180&nbsp;200&nbsp;224</spanx></c>
1968 <c>18</c>
1969 <c><spanx style="vbare">21&nbsp;&nbsp;28&nbsp;&nbsp;70&nbsp;&nbsp;87&nbsp;106&nbsp;124&nbsp;149&nbsp;170&nbsp;194&nbsp;217</spanx></c>
1970 <c>19</c>
1971 <c><spanx style="vbare">26&nbsp;&nbsp;33&nbsp;&nbsp;53&nbsp;&nbsp;64&nbsp;&nbsp;83&nbsp;117&nbsp;152&nbsp;173&nbsp;204&nbsp;225</spanx></c>
1972 <c>20</c>
1973 <c><spanx style="vbare">27&nbsp;&nbsp;34&nbsp;&nbsp;65&nbsp;&nbsp;95&nbsp;108&nbsp;129&nbsp;155&nbsp;174&nbsp;210&nbsp;225</spanx></c>
1974 <c>21</c>
1975 <c><spanx style="vbare">20&nbsp;&nbsp;26&nbsp;&nbsp;72&nbsp;&nbsp;99&nbsp;113&nbsp;131&nbsp;154&nbsp;176&nbsp;200&nbsp;219</spanx></c>
1976 <c>22</c>
1977 <c><spanx style="vbare">34&nbsp;&nbsp;43&nbsp;&nbsp;61&nbsp;&nbsp;78&nbsp;&nbsp;93&nbsp;114&nbsp;155&nbsp;177&nbsp;205&nbsp;229</spanx></c>
1978 <c>23</c>
1979 <c><spanx style="vbare">23&nbsp;&nbsp;29&nbsp;&nbsp;54&nbsp;&nbsp;97&nbsp;124&nbsp;138&nbsp;163&nbsp;179&nbsp;209&nbsp;229</spanx></c>
1980 <c>24</c>
1981 <c><spanx style="vbare">30&nbsp;&nbsp;38&nbsp;&nbsp;56&nbsp;&nbsp;89&nbsp;118&nbsp;129&nbsp;158&nbsp;178&nbsp;200&nbsp;231</spanx></c>
1982 <c>25</c>
1983 <c><spanx style="vbare">21&nbsp;&nbsp;29&nbsp;&nbsp;49&nbsp;&nbsp;63&nbsp;&nbsp;85&nbsp;111&nbsp;142&nbsp;163&nbsp;193&nbsp;222</spanx></c>
1984 <c>26</c>
1985 <c><spanx style="vbare">27&nbsp;&nbsp;48&nbsp;&nbsp;77&nbsp;103&nbsp;133&nbsp;158&nbsp;179&nbsp;196&nbsp;215&nbsp;232</spanx></c>
1986 <c>27</c>
1987 <c><spanx style="vbare">29&nbsp;&nbsp;47&nbsp;&nbsp;74&nbsp;&nbsp;99&nbsp;124&nbsp;151&nbsp;176&nbsp;198&nbsp;220&nbsp;237</spanx></c>
1988 <c>28</c>
1989 <c><spanx style="vbare">33&nbsp;&nbsp;42&nbsp;&nbsp;61&nbsp;&nbsp;76&nbsp;&nbsp;93&nbsp;121&nbsp;155&nbsp;174&nbsp;207&nbsp;225</spanx></c>
1990 <c>29</c>
1991 <c><spanx style="vbare">29&nbsp;&nbsp;53&nbsp;&nbsp;87&nbsp;112&nbsp;136&nbsp;154&nbsp;170&nbsp;188&nbsp;208&nbsp;227</spanx></c>
1992 <c>30</c>
1993 <c><spanx style="vbare">24&nbsp;&nbsp;30&nbsp;&nbsp;52&nbsp;&nbsp;84&nbsp;131&nbsp;150&nbsp;166&nbsp;186&nbsp;203&nbsp;229</spanx></c>
1994 <c>31</c>
1995 <c><spanx style="vbare">37&nbsp;&nbsp;48&nbsp;&nbsp;64&nbsp;&nbsp;84&nbsp;104&nbsp;118&nbsp;156&nbsp;177&nbsp;201&nbsp;230</spanx></c>
1996 </texttable>
1997
1998 <texttable anchor="silk_nlsf_wb_codebook"
1999            title="Codebook Vectors for WB Normalized LSF Stage 1 Decoding">
2000 <ttcol>I1</ttcol>
2001 <ttcol>Codebook</ttcol>
2002 <c/>
2003 <c><spanx style="vbare">&nbsp;0&nbsp;&nbsp;1&nbsp;&nbsp;2&nbsp;&nbsp;3&nbsp;&nbsp;4&nbsp;&nbsp;&nbsp;5&nbsp;&nbsp;&nbsp;6&nbsp;&nbsp;&nbsp;7&nbsp;&nbsp;&nbsp;8&nbsp;&nbsp;&nbsp;9&nbsp;&nbsp;10&nbsp;&nbsp;11&nbsp;&nbsp;12&nbsp;&nbsp;13&nbsp;&nbsp;14&nbsp;&nbsp;15</spanx></c>
2004 <c>0</c>
2005 <c><spanx style="vbare">&nbsp;7&nbsp;23&nbsp;38&nbsp;54&nbsp;69&nbsp;&nbsp;85&nbsp;100&nbsp;116&nbsp;131&nbsp;147&nbsp;162&nbsp;178&nbsp;193&nbsp;208&nbsp;223&nbsp;239</spanx></c>
2006 <c>1</c>
2007 <c><spanx style="vbare">13&nbsp;25&nbsp;41&nbsp;55&nbsp;69&nbsp;&nbsp;83&nbsp;&nbsp;98&nbsp;112&nbsp;127&nbsp;142&nbsp;157&nbsp;171&nbsp;187&nbsp;203&nbsp;220&nbsp;236</spanx></c>
2008 <c>2</c>
2009 <c><spanx style="vbare">15&nbsp;21&nbsp;34&nbsp;51&nbsp;61&nbsp;&nbsp;78&nbsp;&nbsp;92&nbsp;106&nbsp;126&nbsp;136&nbsp;152&nbsp;167&nbsp;185&nbsp;205&nbsp;225&nbsp;240</spanx></c>
2010 <c>3</c>
2011 <c><spanx style="vbare">10&nbsp;21&nbsp;36&nbsp;50&nbsp;63&nbsp;&nbsp;79&nbsp;&nbsp;95&nbsp;110&nbsp;126&nbsp;141&nbsp;157&nbsp;173&nbsp;189&nbsp;205&nbsp;221&nbsp;237</spanx></c>
2012 <c>4</c>
2013 <c><spanx style="vbare">17&nbsp;20&nbsp;37&nbsp;51&nbsp;59&nbsp;&nbsp;78&nbsp;&nbsp;89&nbsp;107&nbsp;123&nbsp;134&nbsp;150&nbsp;164&nbsp;184&nbsp;205&nbsp;224&nbsp;240</spanx></c>
2014 <c>5</c>
2015 <c><spanx style="vbare">10&nbsp;15&nbsp;32&nbsp;51&nbsp;67&nbsp;&nbsp;81&nbsp;&nbsp;96&nbsp;112&nbsp;129&nbsp;142&nbsp;158&nbsp;173&nbsp;189&nbsp;204&nbsp;220&nbsp;236</spanx></c>
2016 <c>6</c>
2017 <c><spanx style="vbare">&nbsp;8&nbsp;21&nbsp;37&nbsp;51&nbsp;65&nbsp;&nbsp;79&nbsp;&nbsp;98&nbsp;113&nbsp;126&nbsp;138&nbsp;155&nbsp;168&nbsp;179&nbsp;192&nbsp;209&nbsp;218</spanx></c>
2018 <c>7</c>
2019 <c><spanx style="vbare">12&nbsp;15&nbsp;34&nbsp;55&nbsp;63&nbsp;&nbsp;78&nbsp;&nbsp;87&nbsp;108&nbsp;118&nbsp;131&nbsp;148&nbsp;167&nbsp;185&nbsp;203&nbsp;219&nbsp;236</spanx></c>
2020 <c>8</c>
2021 <c><spanx style="vbare">16&nbsp;19&nbsp;32&nbsp;36&nbsp;56&nbsp;&nbsp;79&nbsp;&nbsp;91&nbsp;108&nbsp;118&nbsp;136&nbsp;154&nbsp;171&nbsp;186&nbsp;204&nbsp;220&nbsp;237</spanx></c>
2022 <c>9</c>
2023 <c><spanx style="vbare">11&nbsp;28&nbsp;43&nbsp;58&nbsp;74&nbsp;&nbsp;89&nbsp;105&nbsp;120&nbsp;135&nbsp;150&nbsp;165&nbsp;180&nbsp;196&nbsp;211&nbsp;226&nbsp;241</spanx></c>
2024 <c>10</c>
2025 <c><spanx style="vbare">&nbsp;6&nbsp;16&nbsp;33&nbsp;46&nbsp;60&nbsp;&nbsp;75&nbsp;&nbsp;92&nbsp;107&nbsp;123&nbsp;137&nbsp;156&nbsp;169&nbsp;185&nbsp;199&nbsp;214&nbsp;225</spanx></c>
2026 <c>11</c>
2027 <c><spanx style="vbare">11&nbsp;19&nbsp;30&nbsp;44&nbsp;57&nbsp;&nbsp;74&nbsp;&nbsp;89&nbsp;105&nbsp;121&nbsp;135&nbsp;152&nbsp;169&nbsp;186&nbsp;202&nbsp;218&nbsp;234</spanx></c>
2028 <c>12</c>
2029 <c><spanx style="vbare">12&nbsp;19&nbsp;29&nbsp;46&nbsp;57&nbsp;&nbsp;71&nbsp;&nbsp;88&nbsp;100&nbsp;120&nbsp;132&nbsp;148&nbsp;165&nbsp;182&nbsp;199&nbsp;216&nbsp;233</spanx></c>
2030 <c>13</c>
2031 <c><spanx style="vbare">17&nbsp;23&nbsp;35&nbsp;46&nbsp;56&nbsp;&nbsp;77&nbsp;&nbsp;92&nbsp;106&nbsp;123&nbsp;134&nbsp;152&nbsp;167&nbsp;185&nbsp;204&nbsp;222&nbsp;237</spanx></c>
2032 <c>14</c>
2033 <c><spanx style="vbare">14&nbsp;17&nbsp;45&nbsp;53&nbsp;63&nbsp;&nbsp;75&nbsp;&nbsp;89&nbsp;107&nbsp;115&nbsp;132&nbsp;151&nbsp;171&nbsp;188&nbsp;206&nbsp;221&nbsp;240</spanx></c>
2034 <c>15</c>
2035 <c><spanx style="vbare">&nbsp;9&nbsp;16&nbsp;29&nbsp;40&nbsp;56&nbsp;&nbsp;71&nbsp;&nbsp;88&nbsp;103&nbsp;119&nbsp;137&nbsp;154&nbsp;171&nbsp;189&nbsp;205&nbsp;222&nbsp;237</spanx></c>
2036 <c>16</c>
2037 <c><spanx style="vbare">16&nbsp;19&nbsp;36&nbsp;48&nbsp;57&nbsp;&nbsp;76&nbsp;&nbsp;87&nbsp;105&nbsp;118&nbsp;132&nbsp;150&nbsp;167&nbsp;185&nbsp;202&nbsp;218&nbsp;236</spanx></c>
2038 <c>17</c>
2039 <c><spanx style="vbare">12&nbsp;17&nbsp;29&nbsp;54&nbsp;71&nbsp;&nbsp;81&nbsp;&nbsp;94&nbsp;104&nbsp;126&nbsp;136&nbsp;149&nbsp;164&nbsp;182&nbsp;201&nbsp;221&nbsp;237</spanx></c>
2040 <c>18</c>
2041 <c><spanx style="vbare">15&nbsp;28&nbsp;47&nbsp;62&nbsp;79&nbsp;&nbsp;97&nbsp;115&nbsp;129&nbsp;142&nbsp;155&nbsp;168&nbsp;180&nbsp;194&nbsp;208&nbsp;223&nbsp;238</spanx></c>
2042 <c>19</c>
2043 <c><spanx style="vbare">&nbsp;8&nbsp;14&nbsp;30&nbsp;45&nbsp;62&nbsp;&nbsp;78&nbsp;&nbsp;94&nbsp;111&nbsp;127&nbsp;143&nbsp;159&nbsp;175&nbsp;192&nbsp;207&nbsp;223&nbsp;239</spanx></c>
2044 <c>20</c>
2045 <c><spanx style="vbare">17&nbsp;30&nbsp;49&nbsp;62&nbsp;79&nbsp;&nbsp;92&nbsp;107&nbsp;119&nbsp;132&nbsp;145&nbsp;160&nbsp;174&nbsp;190&nbsp;204&nbsp;220&nbsp;235</spanx></c>
2046 <c>21</c>
2047 <c><spanx style="vbare">14&nbsp;19&nbsp;36&nbsp;45&nbsp;61&nbsp;&nbsp;76&nbsp;&nbsp;91&nbsp;108&nbsp;121&nbsp;138&nbsp;154&nbsp;172&nbsp;189&nbsp;205&nbsp;222&nbsp;238</spanx></c>
2048 <c>22</c>
2049 <c><spanx style="vbare">12&nbsp;18&nbsp;31&nbsp;45&nbsp;60&nbsp;&nbsp;76&nbsp;&nbsp;91&nbsp;107&nbsp;123&nbsp;138&nbsp;154&nbsp;171&nbsp;187&nbsp;204&nbsp;221&nbsp;236</spanx></c>
2050 <c>23</c>
2051 <c><spanx style="vbare">13&nbsp;17&nbsp;31&nbsp;43&nbsp;53&nbsp;&nbsp;70&nbsp;&nbsp;83&nbsp;103&nbsp;114&nbsp;131&nbsp;149&nbsp;167&nbsp;185&nbsp;203&nbsp;220&nbsp;237</spanx></c>
2052 <c>24</c>
2053 <c><spanx style="vbare">17&nbsp;22&nbsp;35&nbsp;42&nbsp;58&nbsp;&nbsp;78&nbsp;&nbsp;93&nbsp;110&nbsp;125&nbsp;139&nbsp;155&nbsp;170&nbsp;188&nbsp;206&nbsp;224&nbsp;240</spanx></c>
2054 <c>25</c>
2055 <c><spanx style="vbare">&nbsp;8&nbsp;15&nbsp;34&nbsp;50&nbsp;67&nbsp;&nbsp;83&nbsp;&nbsp;99&nbsp;115&nbsp;131&nbsp;146&nbsp;162&nbsp;178&nbsp;193&nbsp;209&nbsp;224&nbsp;239</spanx></c>
2056 <c>26</c>
2057 <c><spanx style="vbare">13&nbsp;16&nbsp;41&nbsp;66&nbsp;73&nbsp;&nbsp;86&nbsp;&nbsp;95&nbsp;111&nbsp;128&nbsp;137&nbsp;150&nbsp;163&nbsp;183&nbsp;206&nbsp;225&nbsp;241</spanx></c>
2058 <c>27</c>
2059 <c><spanx style="vbare">17&nbsp;25&nbsp;37&nbsp;52&nbsp;63&nbsp;&nbsp;75&nbsp;&nbsp;92&nbsp;102&nbsp;119&nbsp;132&nbsp;144&nbsp;160&nbsp;175&nbsp;191&nbsp;212&nbsp;231</spanx></c>
2060 <c>28</c>
2061 <c><spanx style="vbare">19&nbsp;31&nbsp;49&nbsp;65&nbsp;83&nbsp;100&nbsp;117&nbsp;133&nbsp;147&nbsp;161&nbsp;174&nbsp;187&nbsp;200&nbsp;213&nbsp;227&nbsp;242</spanx></c>
2062 <c>29</c>
2063 <c><spanx style="vbare">18&nbsp;31&nbsp;52&nbsp;68&nbsp;88&nbsp;103&nbsp;117&nbsp;126&nbsp;138&nbsp;149&nbsp;163&nbsp;177&nbsp;192&nbsp;207&nbsp;223&nbsp;239</spanx></c>
2064 <c>30</c>
2065 <c><spanx style="vbare">16&nbsp;29&nbsp;47&nbsp;61&nbsp;76&nbsp;&nbsp;90&nbsp;106&nbsp;119&nbsp;133&nbsp;147&nbsp;161&nbsp;176&nbsp;193&nbsp;209&nbsp;224&nbsp;240</spanx></c>
2066 <c>31</c>
2067 <c><spanx style="vbare">15&nbsp;21&nbsp;35&nbsp;50&nbsp;61&nbsp;&nbsp;73&nbsp;&nbsp;86&nbsp;&nbsp;97&nbsp;110&nbsp;119&nbsp;129&nbsp;141&nbsp;175&nbsp;198&nbsp;218&nbsp;237</spanx></c>
2068 </texttable>
2069
2070 <t>
2071 Given the stage-1 codebook entry cb1_Q8[], the stage-2 residual res_Q10[], and
2072  their corresponding weights, w_Q9[], the reconstructed normalized LSF
2073  coefficients are
2074 <figure align="center">
2075 <artwork align="center"><![CDATA[
2076 NLSF_Q15[k] = (cb1_Q8[k]<<7) + (res_Q10[k]<<14)/w_Q9[k] ,
2077 ]]></artwork>
2078 </figure>
2079  where the division is exact integer division.
2080 However, nothing thus far in the reconstruction process, nor in the
2081  quantization process in the encoder, guarantees that the coefficients are
2082  monotonically increasing and separated well enough to ensure a stable filter.
2083 When using the reference encoder, roughly 2% of frames violate this constraint.
2084 The next section describes a stabilization procedure used to make these
2085  guarantees.
2086 </t>
2087
2088 <section anchor="silk_nlsf_stabilization" title="Normalized LSF Stabilization">
2089 <t>
2090 The normalized LSF stabilization procedure is implemented in
2091  silk_NLSF_stabilize() (silk_NLSF_stabilize.c).
2092 This process ensures that consecutive values of the normalized LSF
2093  coefficients, NLSF_Q15[], are spaced some minimum distance apart
2094  (predetermined to be the 0.01 percentile of a large training set).
2095 <xref target="silk_nlsf_min_spacing"/> gives the minimum spacings for NB and MB
2096  and those for WB, where row k is the minimum allowed value of
2097  NLSF_Q[k]-NLSF_Q[k-1].
2098 For the purposes of computing this spacing for the first and last coefficient,
2099  NLSF_Q15[-1] is taken to be 0, and NLSF_Q15[d_LPC] is taken to be 32768.
2100 </t>
2101
2102 <texttable anchor="silk_nlsf_min_spacing"
2103            title="Minimum Spacing for Normalized LSF Coefficients">
2104 <ttcol>Coefficient</ttcol>
2105 <ttcol align="right">NB and MB</ttcol>
2106 <ttcol align="right">WB</ttcol>
2107  <c>0</c> <c>250</c> <c>100</c>
2108  <c>1</c>   <c>3</c>   <c>3</c>
2109  <c>2</c>   <c>6</c>  <c>40</c>
2110  <c>3</c>   <c>3</c>   <c>3</c>
2111  <c>4</c>   <c>3</c>   <c>3</c>
2112  <c>5</c>   <c>3</c>   <c>3</c>
2113  <c>6</c>   <c>4</c>   <c>5</c>
2114  <c>7</c>   <c>3</c>  <c>14</c>
2115  <c>8</c>   <c>3</c>  <c>14</c>
2116  <c>9</c>   <c>3</c>  <c>10</c>
2117 <c>10</c> <c>461</c>  <c>11</c>
2118 <c>11</c>       <c/>   <c>3</c>
2119 <c>12</c>       <c/>   <c>8</c>
2120 <c>13</c>       <c/>   <c>9</c>
2121 <c>14</c>       <c/>   <c>7</c>
2122 <c>15</c>       <c/>   <c>3</c>
2123 <c>16</c>       <c/> <c>347</c>
2124 </texttable>
2125
2126 <t>
2127 The procedure starts off by trying to make small adjustments which attempt to
2128  minimize the amount of distortion introduced.
2129 After 20 such adjustments, it falls back to a more direct method which
2130  guarantees the constraints are enforced but may require large adjustments.
2131 </t>
2132 <t>
2133 Let NDeltaMin_Q15[k] be the minimum required spacing for the current audio
2134  bandwidth from <xref target="silk_nlsf_min_spacing"/>.
2135 First, the procedure finds the index i where
2136  NLSF_Q15[i]&nbsp;-&nbsp;NLSF_Q15[i-1]&nbsp;-&nbsp;NDeltaMin_Q15[i] is the
2137  smallest, breaking ties by using the lower value of i.
2138 If this value is non-negative, then the stabilization stops; the coefficients
2139  satisfy all the constraints.
2140 Otherwise, if i&nbsp;==&nbsp;0, it sets NLSF_Q15[0] to NDeltaMin_Q15[0], and if
2141  i&nbsp;==&nbsp;d_LPC, it sets NLSF_Q15[d_LPC-1] to
2142  (32768&nbsp;-&nbsp;NDeltaMin_Q15[d_LPC]).
2143 For all other values of i, both NLSF_Q15[i-1] and NLSF_Q15[i] are updated as
2144  follows:
2145 <figure align="center">
2146 <artwork align="center"><![CDATA[
2147                                       i-1
2148                                       __
2149  min_center_Q15 = (NDeltaMin[i]>>1) + \  NDeltaMin[k]
2150                                       /_
2151                                       k=0
2152                                              d_LPC
2153                                               __
2154  max_center_Q15 = 32768 - (NDeltaMin[i]>>1) - \  NDeltaMin[k]
2155                                               /_
2156                                              k=i+1
2157 center_freq_Q15 = clamp(min_center_Q15[i],
2158                         (NLSF_Q15[i-1] + NLSF_Q15[i] + 1)>>1,
2159                         max_center_Q15[i])
2160
2161  NLSF_Q15[i-1] = center_freq_Q15 - (NDeltaMin_Q15[i]>>1)
2162
2163    NLSF_Q15[i] = NLSF_Q15[i-1] + NDeltaMin_Q15[i] .
2164 ]]></artwork>
2165 </figure>
2166 Then the procedure repeats again, until it has executed 20 times, or until
2167  it stops because the coefficients satisfy all the constraints.
2168 </t>
2169 <t>
2170 After the 20th repetition of the above, the following fallback procedure
2171  executes once.
2172 First, the values of NLSF_Q15[k] for 0&nbsp;&lt;=&nbsp;k&nbsp;&lt;&nbsp;d_LPC
2173  are sorted in ascending order.
2174 Then for each value of k from 0 to d_LPC-1, NLSF_Q15[k] is set to
2175 <figure align="center">
2176 <artwork align="center"><![CDATA[
2177 max(NLSF_Q15[k], NLSF_Q15[k-1] + NDeltaMin_Q15[k]) .
2178 ]]></artwork>
2179 </figure>
2180 Next, for each value of k from d_LPC-1 down to 0, NLSF_Q15[k] is set to
2181 <figure align="center">
2182 <artwork align="center"><![CDATA[
2183 min(NLSF_Q15[k], NLSF_Q15[k+1] - NDeltaMin_Q15[k+1]) .
2184 ]]></artwork>
2185 </figure>
2186 </t>
2187
2188 </section>
2189
2190 <section anchor="silk_nlsf_interpolation" title="Normalized LSF Interpolation">
2191 <t>
2192 For 20&nbsp;ms SILK frames, the first half of the frame (i.e., the first two
2193  sub-frames) may use normalized LSF coefficients that are interpolated between
2194  the decoded LSFs for the previous frame and the current frame.
2195 A Q2 interpolation factor follows the LSF coefficient indices in the bitstream,
2196  which is decoded using the PDF in <xref target="silk_nlsf_interp_pdf"/>.
2197 This happens in silk_decode_indices() (silk_decode_indices.c).
2198 For the first frame after a decoder reset, when no prior LSF coefficients are
2199  available, the decoder still decodes this factor, but ignores its value and
2200  always uses 4 instead.
2201 For 10&nbsp;ms SILK frames, this factor is not stored at all.
2202 </t>
2203
2204 <texttable anchor="silk_nlsf_interp_pdf"
2205            title="PDF for Normalized LSF Interpolation Index">
2206 <ttcol>PDF</ttcol>
2207 <c>{13, 22, 29, 11, 181}/256</c>
2208 </texttable>
2209
2210 <t>
2211 Let n2_Q15[k] be the normalized LSF coefficients decoded by the procedure in
2212  <xref target="silk_nlsfs"/>, n0_Q15[k] be the LSF coefficients
2213  decoded for the prior frame, and w_Q2 be the interpolation factor.
2214 Then the normalized LSF coefficients used for the first half of a 20&nbsp;ms
2215  frame, n1_Q15[k], are
2216 <figure align="center">
2217 <artwork align="center"><![CDATA[
2218 n1_Q15[k] = n0_Q15[k] + (w_Q2*(n2_Q15[k] - n0_Q15[k]) >> 2) .
2219 ]]></artwork>
2220 </figure>
2221 This interpolation is performed in silk_decode_parameters()
2222  (silk_decode_parameters.c).
2223 </t>
2224 </section>
2225
2226 <section anchor="silk_nlsf2lpc"
2227          title="Converting Normalized LSF Coefficients to LPCs">
2228 <t>
2229 Any LPC filter A(z) can be split into a symmetric part P(z) and an
2230  anti-symmetric part Q(z) such that
2231 <figure align="center">
2232 <artwork align="center"><![CDATA[
2233           d_LPC
2234            __         -k   1
2235 A(z) = 1 - \  a[k] * z   = - * (P(z) + Q(z))
2236            /_              2
2237            k=1
2238 ]]></artwork>
2239 </figure>
2240 with
2241 <figure align="center">
2242 <artwork align="center"><![CDATA[
2243                -d_LPC-1      -1
2244 P(z) = A(z) + z         * A(z  )
2245
2246                -d_LPC-1      -1
2247 Q(z) = A(z) - z         * A(z  ) .
2248 ]]></artwork>
2249 </figure>
2250 The even normalized LSF coefficients correspond to a pair of conjugate roots of
2251  P(z), while the odd coefficients correspond to a pair of conjugate roots of
2252  Q(z), all of which lie on the unit circle.
2253 In addition, P(z) has a root at pi and Q(z) has a root at 0.
2254 Thus, they may be reconstructed mathematically from a set of normalized LSF
2255  coefficients, n[k], as
2256 <figure align="center">
2257 <artwork align="center"><![CDATA[
2258                  d_LPC/2-1
2259              -1     ___                        -1    -2
2260 P(z) = (1 + z  ) *  | |  (1 - 2*cos(pi*n[2*k])*z  + z  )
2261                     k=0
2262
2263                  d_LPC/2-1
2264              -1     ___                          -1    -2
2265 Q(z) = (1 - z  ) *  | |  (1 - 2*cos(pi*n[2*k+1])*z  + z  )
2266                     k=0
2267 ]]></artwork>
2268 </figure>
2269 </t>
2270 <t>
2271 However, SILK performs this reconstruction using a fixed-point approximation so
2272  that all decoders can reproduce it in a bit-exact manner to avoid prediction
2273  drift.
2274 The function silk_NLSF2A() (silk_NLSF2A.c) implements this procedure.
2275 </t>
2276 <t>
2277 To start, it approximates cos(pi*n[k]) using a table lookup with linear
2278  interpolation.
2279 The encoder SHOULD use the inverse of this piecewise linear approximation,
2280  rather than true the inverse of the cosine function, when deriving the
2281  normalized LSF coefficients.
2282 </t>
2283 <t>
2284 The top 7 bits of each normalized LSF coefficient index a value in the table,
2285  and the next 8 bits interpolate between it and the next value.
2286 Let i&nbsp;=&nbsp;n[k]&gt;&gt;8 be the integer index and
2287  f&nbsp;=&nbsp;n[k]&amp;255 be the fractional part of a given coefficient.
2288 Then the approximated cosine, c_Q17[k], is
2289 <figure align="center">
2290 <artwork align="center"><![CDATA[
2291 c_Q17[k] = (cos_Q13[i]*256 + (cos_Q13[i+1]-cos_Q13[i])*f + 8) >> 4 ,
2292 ]]></artwork>
2293 </figure>
2294  where cos_Q13[i] is the corresponding entry of
2295  <xref target="silk_cos_table"/>.
2296 </t>
2297
2298 <texttable anchor="silk_cos_table"
2299            title="Q13 Cosine Table for LSF Conversion">
2300 <ttcol align="right"></ttcol>
2301 <ttcol align="right">0</ttcol>
2302 <ttcol align="right">1</ttcol>
2303 <ttcol align="right">2</ttcol>
2304 <ttcol align="right">3</ttcol>
2305 <c>0</c>
2306  <c>8192</c> <c>8190</c> <c>8182</c> <c>8170</c>
2307 <c>4</c>
2308  <c>8152</c> <c>8130</c> <c>8104</c> <c>8072</c>
2309 <c>8</c>
2310  <c>8034</c> <c>7994</c> <c>7946</c> <c>7896</c>
2311 <c>12</c>
2312  <c>7840</c> <c>7778</c> <c>7714</c> <c>7644</c>
2313 <c>16</c>
2314  <c>7568</c> <c>7490</c> <c>7406</c> <c>7318</c>
2315 <c>20</c>
2316  <c>7226</c> <c>7128</c> <c>7026</c> <c>6922</c>
2317 <c>24</c>
2318  <c>6812</c> <c>6698</c> <c>6580</c> <c>6458</c>
2319 <c>28</c>
2320  <c>6332</c> <c>6204</c> <c>6070</c> <c>5934</c>
2321 <c>32</c>
2322  <c>5792</c> <c>5648</c> <c>5502</c> <c>5352</c>
2323 <c>36</c>
2324  <c>5198</c> <c>5040</c> <c>4880</c> <c>4718</c>
2325 <c>40</c>
2326  <c>4552</c> <c>4382</c> <c>4212</c> <c>4038</c>
2327 <c>44</c>
2328  <c>3862</c> <c>3684</c> <c>3502</c> <c>3320</c>
2329 <c>48</c>
2330  <c>3136</c> <c>2948</c> <c>2760</c> <c>2570</c>
2331 <c>52</c>
2332  <c>2378</c> <c>2186</c> <c>1990</c> <c>1794</c>
2333 <c>56</c>
2334  <c>1598</c> <c>1400</c> <c>1202</c> <c>1002</c>
2335 <c>60</c>
2336   <c>802</c>  <c>602</c>  <c>402</c>  <c>202</c>
2337 <c>64</c>
2338     <c>0</c> <c>-202</c> <c>-402</c> <c>-602</c>
2339 <c>68</c>
2340  <c>-802</c><c>-1002</c><c>-1202</c><c>-1400</c>
2341 <c>72</c>
2342 <c>-1598</c><c>-1794</c><c>-1990</c><c>-2186</c>
2343 <c>76</c>
2344 <c>-2378</c><c>-2570</c><c>-2760</c><c>-2948</c>
2345 <c>80</c>
2346 <c>-3136</c><c>-3320</c><c>-3502</c><c>-3684</c>
2347 <c>84</c>
2348 <c>-3862</c><c>-4038</c><c>-4212</c><c>-4382</c>
2349 <c>88</c>
2350 <c>-4552</c><c>-4718</c><c>-4880</c><c>-5040</c>
2351 <c>92</c>
2352 <c>-5198</c><c>-5352</c><c>-5502</c><c>-5648</c>
2353 <c>96</c>
2354 <c>-5792</c><c>-5934</c><c>-6070</c><c>-6204</c>
2355 <c>100</c>
2356 <c>-6332</c><c>-6458</c><c>-6580</c><c>-6698</c>
2357 <c>104</c>
2358 <c>-6812</c><c>-6922</c><c>-7026</c><c>-7128</c>
2359 <c>108</c>
2360 <c>-7226</c><c>-7318</c><c>-7406</c><c>-7490</c>
2361 <c>112</c>
2362 <c>-7568</c><c>-7644</c><c>-7714</c><c>-7778</c>
2363 <c>116</c>
2364 <c>-7840</c><c>-7896</c><c>-7946</c><c>-7994</c>
2365 <c>120</c>
2366 <c>-8034</c><c>-8072</c><c>-8104</c><c>-8130</c>
2367 <c>124</c>
2368 <c>-8152</c><c>-8170</c><c>-8182</c><c>-8190</c>
2369 <c>128</c>
2370 <c>-8192</c>        <c/>        <c/>        <c/>
2371 </texttable>
2372
2373 <t>
2374 Given the list of cosine values, silk_NLSF2A_find_poly() (silk_NLSF2A.c)
2375  computes the coefficients of P and Q, described here via a simple recurrence.
2376 Let p_Q16[k][j] and q_Q16[k][j] be the coefficients of the products of the
2377  first (k+1) root pairs for P and Q, with j indexing the coefficient number.
2378 Only the first (k+2) coefficients are needed, as the products are symmetric.
2379 Let p_Q16[0][0]&nbsp;=&nbsp;q_Q16[0][0]&nbsp;=&nbsp;1&lt;&lt;16,
2380  p_Q16[0][1]&nbsp;=&nbsp;-c_Q17[0], q_Q16[0][1]&nbsp;=&nbsp;-c_Q17[1], and
2381  d2&nbsp;=&nbsp;d_LPC/2.
2382 As boundary conditions, assume
2383  p_Q16[k][j]&nbsp;=&nbsp;q_Q16[k][j]&nbsp;=&nbsp;0 for all
2384  j&nbsp;&lt;&nbsp;0.
2385 Also, assume p_Q16[k][k+2]&nbsp;=&nbsp;p_Q16[k][k] and
2386  q_Q16[k][k+2]&nbsp;=&nbsp;q_Q16[k][k] (because of the symmetry).
2387 Then, for 0&nbsp;&lt;k&nbsp;&lt;&nbsp;d2 and 0&nbsp;&lt;=&nbsp;j&nbsp;&lt;=&nbsp;k+1,
2388 <figure align="center">
2389 <artwork align="center"><![CDATA[
2390 p_Q16[k][j] = p_Q16[k-1][j] + p_Q16[k-1][j-2]
2391               - ((c_Q17[2*k]*p_Q16[k-1][j-1] + 32768)>>16) ,
2392
2393 q_Q16[k][j] = q_Q16[k-1][j] + q_Q16[k-1][j-2]
2394               - ((c_Q17[2*k+1]*q_Q16[k-1][j-1] + 32768)>>16) .
2395 ]]></artwork>
2396 </figure>
2397 The use of Q17 values for the cosine terms in an otherwise Q16 expression
2398  implicitly scales them by a factor of 2.
2399 The multiplications in this recurrence may require up to 48 bits of precision
2400  in the result to avoid overflow.
2401 In practice, each row of the recurrence only depends on the previous row, so an
2402  implementation does not need to store all of them.
2403 </t>
2404 <t>
2405 silk_NLSF2A() uses the values from the last row of this recurrence to
2406  reconstruct a 32-bit version of the LPC filter (without the leading 1.0
2407  coefficient), a32_Q17[k], 0&nbsp;&lt;=&nbsp;k&nbsp;&lt;&nbsp;d2:
2408 <figure align="center">
2409 <artwork align="center"><![CDATA[
2410 a32_Q17[k]         = -(q_Q16[d2-1][k+1] - q_Q16[d2-1][k])
2411                      - (p_Q16[d2-1][k+1] + p_Q16[d2-1][k])) ,
2412
2413 a32_Q17[d_LPC-k-1] =  (q_Q16[d2-1][k+1] - q_Q16[d2-1][k])
2414                      - (p_Q16[d2-1][k+1] + p_Q16[d2-1][k])) .
2415 ]]></artwork>
2416 </figure>
2417 The sum and difference of two terms from each of the p_Q16 and q_Q16
2418  coefficient lists reflect the (1&nbsp;+&nbsp;z**-1) and
2419  (1&nbsp;-&nbsp;z**-1) factors of P and Q, respectively.
2420 The promotion of the expression from Q16 to Q17 implicitly scales the result
2421  by 1/2.
2422 </t>
2423 </section>
2424
2425 <section anchor="silk_lpc_range"
2426  title="Limiting the Range of the LPC Coefficients">
2427 <t>
2428 The a32_Q17[] coefficients are too large to fit in a 16-bit value, which
2429  significantly increases the cost of applying this filter in fixed-point
2430  decoders.
2431 Reducing them to Q12 precision doesn't incur any significant quality loss,
2432  but still does not guarantee they will fit.
2433 silk_NLSF2A() applies up to 10 rounds of bandwidth expansion to limit
2434  the dynamic range of these coefficients.
2435 Even floating-point decoders SHOULD perform these steps, to avoid mismatch.
2436 </t>
2437 <t>
2438 For each round, the process first finds the index k such that abs(a32_Q17[k])
2439  is the largest, breaking ties by using the lower value of k.
2440 Then, it computes the corresponding Q12 precision value, maxabs_Q12, subject to
2441  an upper bound to avoid overflow in subsequent computations:
2442 <figure align="center">
2443 <artwork align="center"><![CDATA[
2444 maxabs_Q12 = min((maxabs_Q17 + 16) >> 5, 163838) .
2445 ]]></artwork>
2446 </figure>
2447 If this is larger than 32767, the procedure derives the chirp factor,
2448  sc_Q16[0], to use in the bandwidth expansion as
2449 <figure align="center">
2450 <artwork align="center"><![CDATA[
2451                     (maxabs_Q12 - 32767) << 14
2452 sc_Q16[0] = 65470 - -------------------------- ,
2453                     (maxabs_Q12 * (k+1)) >> 2
2454 ]]></artwork>
2455 </figure>
2456  where the division here is exact integer division.
2457 This is an approximation of the chirp factor needed to reduce the target
2458  coefficient to 32767, though it is both less than 0.999 and, for
2459  k&nbsp;&gt;&nbsp;0 when maxabs_Q12 is much greater than 32767, still slightly
2460  too large.
2461 </t>
2462 <t>
2463 silk_bwexpander_32() (silk_bwexpander_32.c) peforms the bandwidth expansion
2464  (again, only when maxabs_Q12 is greater than 32767) using the following
2465  recurrence:
2466 <figure align="center">
2467 <artwork align="center"><![CDATA[
2468  a32_Q17[k] = (a32_Q17[k]*sc_Q16[k]) >> 16
2469
2470 sc_Q16[k+1] = (sc_Q16[0]*sc_Q16[k] + 32768) >> 16
2471 ]]></artwork>
2472 </figure>
2473 The first multiply may require up to 48 bits of precision in the result to
2474  avoid overflow.
2475 The second multiply must be unsigned to avoid overflow with only 32 bits of
2476  precision.
2477 The reference implementation uses a slightly more complex formulation that
2478  avoids the 32-bit overflow using signed multiplication, but is otherwise
2479  equivalent.
2480 </t>
2481 <t>
2482 After 10 rounds of bandwidth expansion are performed, they are simply saturated
2483  to 16 bits:
2484 <figure align="center">
2485 <artwork align="center"><![CDATA[
2486 a32_Q17[k] = clamp(-32768, (a32_Q17[k]+16) >> 5, 32767) << 5 .
2487 ]]></artwork>
2488 </figure>
2489 Because this performs the actual saturation in the Q12 domain, but converts the
2490  coefficients back to the Q17 domain for the purposes of prediction gain
2491  limiting, this step must be performed after the 10th round of bandwidth
2492  expansion, regardless of whether or not the Q12 version of any of the
2493  coefficients still overflow a 16-bit integer.
2494 This saturation is not performed if maxabs_Q12 drops to 32767 or less prior to
2495  the 10th round.
2496 </t>
2497 </section>
2498
2499 <section title="Limiting the Prediction Gain of the LPC Filter">
2500 <t>
2501 Even if the Q12 coefficients would fit, the resulting filter may still have a
2502  significant gain (especially for voiced sounds), making the filter unstable.
2503 silk_NLSF2A() applies up to 18 additional rounds of bandwidth expansion to
2504  limit the prediction gain.
2505 Instead of controlling the amount of bandwidth expansion using the prediction
2506  gain itself (which may diverge to infinity for an unstable filter),
2507  silk_NLSF2A() uses LPC_inverse_pred_gain_QA() (silk_LPC_inv_pred_gain.c)
2508  to compute the reflection coefficients associated with the filter.
2509 The filter is stable if and only if the magnitude of these coefficients is
2510  sufficiently less than one.
2511 The reflection coefficients, rc[k], can be computed using a simple Levinson
2512  recurrence, initialized with the LPC coefficients
2513  a[d_LPC-1][n]&nbsp;=&nbsp;a[n], and then updated via
2514 <figure align="center">
2515 <artwork align="center"><![CDATA[
2516     rc[k] = -a[k][k] ,
2517
2518             a[k][n] - a[k][k-n-1]*rc[k]
2519 a[k-1][n] = --------------------------- .
2520                              2
2521                     1 - rc[k]
2522 ]]></artwork>
2523 </figure>
2524 </t>
2525 <t>
2526 However, LPC_inverse_pred_gain_QA() approximates this using fixed-point
2527  arithmetic to guarantee reproducible results across platforms and
2528  implementations.
2529 It is important to run on the real Q12 coefficients that will be used during
2530  reconstruction, because small changes in the coefficients can make a stable
2531  filter unstable, but increasing the precision back to Q16 allows more accurate
2532  computation of the reflection coefficients.
2533 Thus, let
2534 <figure align="center">
2535 <artwork align="center"><![CDATA[
2536 a32_Q16[d_LPC-1][n] = ((a32_Q17[n] + 16) >> 5) << 4
2537 ]]></artwork>
2538 </figure>
2539  be the Q16 representation of the Q12 version of the LPC coefficients that will
2540  eventually be used.
2541 Then for each k from d_LPC-1 down to 0, if
2542  abs(a32_Q16[k][k])&nbsp;&gt;&nbsp;65520, the filter is unstable and the
2543  recurrence stops.
2544 Otherwise, the row k-1 of a32_Q16 is computed from row k as
2545 <figure align="center">
2546 <artwork align="center"><![CDATA[
2547       rc_Q31[k] = -a32_Q16[k][k] << 15 ,
2548
2549      div_Q30[k] = (1<<30) - 1 - (rc_Q31[k]*rc_Q31[k] >> 32) ,
2550
2551           b1[k] = ilog(div_Q30[k]) - 16 ,
2552
2553                         (1<<29) - 1
2554      inv_Qb1[k] = ----------------------- ,
2555                   div_Q30[k] >> (b1[k]+1)
2556
2557      err_Q29[k] = (1<<29)
2558                   - ((div_Q30[k]<<(15-b1[k]))*inv_Qb1[k] >> 16) ,
2559
2560      mul_Q16[k] = ((inv_Qb1[k] << 16)
2561                    + (err_Q29[k]*inv_Qb1[k] >> 13)) >> b1[k] ,
2562
2563           b2[k] = ilog(mul_Q16[k]) - 15 ,
2564
2565   t_Q16[k-1][n] = a32_Q16[k][n]
2566                   - ((a32_Q16[k][k-n-1]*rc_Q31[k] >> 32) << 1) ,
2567
2568 a32_Q16[k-1][n] = ((t_Q16[k-1][n] *
2569                     (mul_Q16[k] << (16-b2[k]))) >> 32) << b2[k] .
2570 ]]></artwork>
2571 </figure>
2572 Here, rc_Q30[k] are the reflection coefficients.
2573 div_Q30[k] is the denominator for each iteration, and mul_Q16[k] is its
2574  multiplicative inverse.
2575 inv_Qb1[k], which ranges from 16384 to 32767, is a low-precision version of
2576  that inverse (with b1[k] fractional bits, where b1[k] ranges from 3 to 14).
2577 err_Q29[k] is the residual error, ranging from -32392 to 32763, which is used
2578  to improve the accuracy.
2579 t_Q16[k-1][n], 0&nbsp;&lt;=&nbsp;n&nbsp;&lt;&nbsp;k, are the numerators for the
2580  next row of coefficients in the recursion, and a32_Q16[k-1][n] is the final
2581  version of that row.
2582 Every multiply in this procedure except the one used to compute mul_Q16[k]
2583  requires more than 32 bits of precision, but otherwise all intermediate
2584  results fit in 32 bits or less.
2585 In practice, because each row only depends on the next one, an implementation
2586  does not need to store them all.
2587 If abs(a32_Q16[k][k])&nbsp;&lt;=&nbsp;65520 for
2588  0&nbsp;&lt;=&nbsp;k&nbsp;&lt;&nbsp;d_LPC, then the filter is considerd stable.
2589 </t>
2590 <t>
2591 On round i, 1&nbsp;&lt;=&nbsp;i&nbsp;&lt;=&nbsp;18, if the filter passes this
2592  stability check, then this procedure stops, and the final LPC coefficients to
2593  use for reconstruction<!--TODO: In section...--> are
2594 <figure align="center">
2595 <artwork align="center"><![CDATA[
2596 a_Q12[k] = (a32_Q17[k] + 16) >> 5 .
2597 ]]></artwork>
2598 </figure>
2599 Otherwise, a round of bandwidth expansion is applied using the same procedure
2600  as in <xref target="silk_lpc_range"/>, with
2601 <figure align="center">
2602 <artwork align="center"><![CDATA[
2603 sc_Q16[0] = 65536 - i*(i+9) .
2604 ]]></artwork>
2605 </figure>
2606 If, after the 18th round, the filter still fails the stability check, then
2607  a_Q12[k] is set to 0 for all k.
2608 </t>
2609 </section>
2610
2611 </section>
2612
2613 <section title="Long-Term Prediction (LTP) Parameters">
2614 <t>
2615 After the normalized LSF indices and, for 20&nbsp;ms frames, the LSF
2616  interpolation index, voiced frames (see <xref target="silk_frame_type"/>)
2617  include additional Long-Term Prediction (LTP) parameters.
2618 There is one primary lag index for each SILK frame, but this is refined to
2619  produce a separate lag index per subframe using a vector quantizer.
2620 Each subframe also gets its own prediction gain coefficient.
2621 </t>
2622
2623 <section title="Pitch Lags">
2624 <t>
2625 The primary lag index is coded either relative to the primary lag of the prior
2626  frame or as an absolute index.
2627 Like the quantization gains, the first LBRR frame, an LBRR frame where the
2628  previous LBRR frame was not coded, or the first regular SILK frame in an Opus
2629  frame all code the pitch lag as an absolute index.
2630 When the prior frame was not voiced, this also forces absolute coding.
2631 </t>
2632 <t>
2633 With absolute coding, the primary pitch lag may range from 2&nbsp;ms
2634  (inclusive) up to 18&nbsp;ms (exclusive), corresponding to pitches from
2635  500&nbsp;Hz down to 55.6&nbsp;Hz, respectively.
2636 It is comprised of a high part and a low part, where the decoder reads the high
2637  part using the 32-entry codebook in <xref target="silk_abs_pitch_high_pdf"/>
2638  and the low part using the codebook corresponding to the current audio
2639  bandwidth from <xref target="silk_abs_pitch_low_pdf"/>.
2640 The final primary pitch lag is then
2641 <figure align="center">
2642 <artwork align="center"><![CDATA[
2643 lag = lag_high*lag_scale + lag_low + lag_min
2644 ]]></artwork>
2645 </figure>
2646  where lag_high is the high part, lag_low is the low part, and lag_scale
2647  and lag_min are the values from the "Scale" and "Minimum Lag" columns of
2648  <xref target="silk_abs_pitch_low_pdf"/>, respectively.
2649 </t>
2650
2651 <texttable anchor="silk_abs_pitch_high_pdf"
2652  title="PDF for High Part of Primary Pitch Lag">
2653 <ttcol align="left">PDF</ttcol>
2654 <c>{3,   3,   6,  11,  21,  30,  32,  19,
2655    11,  10,  12,  13,  13,  12,  11,   9,
2656     8,   7,   6,   4,   2,   2,   2,   1,
2657     1,   1,   1,   1,   1,   1,   1,   1}/256</c>
2658 </texttable>
2659
2660 <texttable anchor="silk_abs_pitch_low_pdf"
2661  title="PDF for Low Part of Primary Pitch Lag">
2662 <ttcol>Audio Bandwidth</ttcol>
2663 <ttcol>PDF</ttcol>
2664 <ttcol>Scale</ttcol>
2665 <ttcol>Minimum Lag</ttcol>
2666 <ttcol>Maximum Lag</ttcol>
2667 <c>NB</c> <c>{64, 64, 64, 64}/256</c>                 <c>4</c> <c>16</c> <c>144</c>
2668 <c>MB</c> <c>{43, 42, 43, 43, 42, 43}/256</c>         <c>6</c> <c>24</c> <c>216</c>
2669 <c>WB</c> <c>{32, 32, 32, 32, 32, 32, 32, 32}/256</c> <c>8</c> <c>32</c> <c>288</c>
2670 </texttable>
2671
2672 <t>
2673 All frames that do not use absolute coding for the primary lag index use
2674  relative coding instead.
2675 The decoder reads a single delta value using the 21-entry PDF in
2676  <xref target="silk_rel_pitch_pdf"/>.
2677 If the resulting value is zero, it falls back to the absolute coding procedure
2678  from the prior paragraph.
2679 Otherwise, the final primary pitch lag is then
2680 <figure align="center">
2681 <artwork align="center"><![CDATA[
2682 lag = lag_prev + (delta_lag_index - 9)
2683 ]]></artwork>
2684 </figure>
2685  where lag_prev is the primary pitch lag from the previous frame and
2686  delta_lag_index is the value just decoded.
2687 This allows a per-frame change in the pitch lag of -8 to +11 samples.
2688 The decoder does no clamping at this point, so this value can fall outside the
2689  range of 2&nbsp;ms to 18&nbsp;ms, and the decoder must use this unclamped
2690  value when using relative coding in the next SILK frame (if any).
2691 However, because an Opus frame can use relative coding for at most two
2692  consecutive SILK frames, integer overflow should not be an issue.
2693 </t>
2694
2695 <texttable anchor="silk_rel_pitch_pdf"
2696  title="PDF for Pitch Lag Change">
2697 <ttcol align="left">PDF</ttcol>
2698 <c>{46,  2,  2,  3,  4,  6, 10, 15,
2699     26, 38, 30, 22, 15, 10,  7,  6,
2700      4,  4,  2,  2,  2}/256</c>
2701 </texttable>
2702
2703 <t>
2704 After the primary pitch lag, a "pitch contour", stored as a single entry from
2705  one of four small VQ codebooks, gives lag offsets for each subframe in the
2706  current SILK frame.
2707 The codebook index is decoded using one of the PDFs in
2708  <xref target="silk_pitch_contour_pdfs"/> depending on the current frame size
2709  and audio bandwidth.
2710 <xref target="silk_pitch_contour_cb_nb10ms"/> through
2711  <xref target="silk_pitch_contour_cb_mbwb20ms"/> give the corresponding offsets
2712  to apply to the primary pitch lag for each subframe given the decoded codebook
2713  index.
2714 </t>
2715
2716 <texttable anchor="silk_pitch_contour_pdfs"
2717  title="PDFs for Subframe Pitch Contour">
2718 <ttcol>Audio Bandwidth</ttcol>
2719 <ttcol>SILK Frame Size</ttcol>
2720 <ttcol>PDF</ttcol>
2721 <c>NB</c>       <c>10&nbsp;ms</c>
2722 <c>{143, 50, 63}/256</c>
2723 <c>NB</c>       <c>20&nbsp;ms</c>
2724 <c>{68, 12, 21, 17, 19, 22, 30, 24,
2725     17, 16, 10}/256</c>
2726 <c>MB or WB</c> <c>10&nbsp;ms</c>
2727 <c>{91, 46, 39, 19, 14, 12,  8,  7,
2728      6,  5,  5,  4}/256</c>
2729 <c>MB or WB</c> <c>20&nbsp;ms</c>
2730 <c>{33, 22, 18, 16, 15, 14, 14, 13,
2731     13, 10,  9,  9,  8,  6,  6,  6,
2732      5,  4,  4,  4,  3,  3,  3,  2,
2733      2,  2,  2,  2,  2,  2,  1,  1,
2734      1,  1}</c>
2735 </texttable>
2736
2737 <texttable anchor="silk_pitch_contour_cb_nb10ms"
2738  title="Codebook Vectors for Subframe Pitch Contour: NB, 10&nbsp;ms Frames">
2739 <ttcol>Index</ttcol>
2740 <ttcol align="right">Subframe Offsets</ttcol>
2741 <c>0</c> <c><spanx style="vbare">&nbsp;0,&nbsp;&nbsp;0</spanx></c>
2742 <c>1</c> <c><spanx style="vbare">&nbsp;1,&nbsp;&nbsp;0</spanx></c>
2743 <c>2</c> <c><spanx style="vbare">&nbsp;0,&nbsp;&nbsp;1</spanx></c>
2744 </texttable>
2745
2746 <texttable anchor="silk_pitch_contour_cb_nb20ms"
2747  title="Codebook Vectors for Subframe Pitch Contour: NB, 20&nbsp;ms Frames">
2748 <ttcol>Index</ttcol>
2749 <ttcol align="right">Subframe Offsets</ttcol>
2750  <c>0</c> <c><spanx style="vbare">&nbsp;0,&nbsp;&nbsp;0,&nbsp;&nbsp;0,&nbsp;&nbsp;0</spanx></c>
2751  <c>1</c> <c><spanx style="vbare">&nbsp;2,&nbsp;&nbsp;1,&nbsp;&nbsp;0,&nbsp;-1</spanx></c>
2752  <c>2</c> <c><spanx style="vbare">-1,&nbsp;&nbsp;0,&nbsp;&nbsp;1,&nbsp;&nbsp;2</spanx></c>
2753  <c>3</c> <c><spanx style="vbare">-1,&nbsp;&nbsp;0,&nbsp;&nbsp;0,&nbsp;&nbsp;1</spanx></c>
2754  <c>4</c> <c><spanx style="vbare">-1,&nbsp;&nbsp;0,&nbsp;&nbsp;0,&nbsp;&nbsp;0</spanx></c>
2755  <c>5</c> <c><spanx style="vbare">&nbsp;0,&nbsp;&nbsp;0,&nbsp;&nbsp;0,&nbsp;&nbsp;1</spanx></c>
2756  <c>6</c> <c><spanx style="vbare">&nbsp;0,&nbsp;&nbsp;0,&nbsp;&nbsp;1,&nbsp;&nbsp;1</spanx></c>
2757  <c>7</c> <c><spanx style="vbare">&nbsp;1,&nbsp;&nbsp;1,&nbsp;&nbsp;0,&nbsp;&nbsp;0</spanx></c>
2758  <c>8</c> <c><spanx style="vbare">&nbsp;1,&nbsp;&nbsp;0,&nbsp;&nbsp;0,&nbsp;&nbsp;0</spanx></c>
2759  <c>9</c> <c><spanx style="vbare">&nbsp;0,&nbsp;&nbsp;0,&nbsp;&nbsp;0,&nbsp;-1</spanx></c>
2760 <c>10</c> <c><spanx style="vbare">&nbsp;1,&nbsp;&nbsp;0,&nbsp;&nbsp;0,&nbsp;-1</spanx></c>
2761 </texttable>
2762
2763 <texttable anchor="silk_pitch_contour_cb_mbwb10ms"
2764  title="Codebook Vectors for Subframe Pitch Contour: MB or WB, 10&nbsp;ms Frames">
2765 <ttcol>Index</ttcol>
2766 <ttcol align="right">Subframe Offsets</ttcol>
2767  <c>0</c> <c><spanx style="vbare">&nbsp;0,&nbsp;&nbsp;0</spanx></c>
2768  <c>1</c> <c><spanx style="vbare">&nbsp;0,&nbsp;&nbsp;1</spanx></c>
2769  <c>2</c> <c><spanx style="vbare">&nbsp;1,&nbsp;&nbsp;0</spanx></c>
2770  <c>3</c> <c><spanx style="vbare">-1,&nbsp;&nbsp;1</spanx></c>
2771  <c>4</c> <c><spanx style="vbare">&nbsp;1,&nbsp;-1</spanx></c>
2772  <c>5</c> <c><spanx style="vbare">-1,&nbsp;&nbsp;2</spanx></c>
2773  <c>6</c> <c><spanx style="vbare">&nbsp;2,&nbsp;-1</spanx></c>
2774  <c>7</c> <c><spanx style="vbare">-2,&nbsp;&nbsp;2</spanx></c>
2775  <c>8</c> <c><spanx style="vbare">&nbsp;2,&nbsp;-2</spanx></c>
2776  <c>9</c> <c><spanx style="vbare">-2,&nbsp;&nbsp;3</spanx></c>
2777 <c>10</c> <c><spanx style="vbare">&nbsp;3,&nbsp;-2</spanx></c>
2778 <c>11</c> <c><spanx style="vbare">-3,&nbsp;&nbsp;3</spanx></c>
2779 </texttable>
2780
2781 <texttable anchor="silk_pitch_contour_cb_mbwb20ms"
2782  title="Codebook Vectors for Subframe Pitch Contour: MB or WB, 20&nbsp;ms Frames">
2783 <ttcol>Index</ttcol>
2784 <ttcol align="right">Subframe Offsets</ttcol>
2785  <c>0</c> <c><spanx style="vbare">&nbsp;0,&nbsp;&nbsp;0,&nbsp;&nbsp;0,&nbsp;&nbsp;0</spanx></c>
2786  <c>1</c> <c><spanx style="vbare">&nbsp;0,&nbsp;&nbsp;0,&nbsp;&nbsp;1,&nbsp;&nbsp;1</spanx></c>
2787  <c>2</c> <c><spanx style="vbare">&nbsp;1,&nbsp;&nbsp;1,&nbsp;&nbsp;0,&nbsp;&nbsp;0</spanx></c>
2788  <c>3</c> <c><spanx style="vbare">-1,&nbsp;&nbsp;0,&nbsp;&nbsp;0,&nbsp;&nbsp;0</spanx></c>
2789  <c>4</c> <c><spanx style="vbare">&nbsp;0,&nbsp;&nbsp;0,&nbsp;&nbsp;0,&nbsp;&nbsp;1</spanx></c>
2790  <c>5</c> <c><spanx style="vbare">&nbsp;1,&nbsp;&nbsp;0,&nbsp;&nbsp;0,&nbsp;&nbsp;0</spanx></c>
2791  <c>6</c> <c><spanx style="vbare">-1,&nbsp;&nbsp;0,&nbsp;&nbsp;0,&nbsp;&nbsp;1</spanx></c>
2792  <c>7</c> <c><spanx style="vbare">&nbsp;0,&nbsp;&nbsp;0,&nbsp;&nbsp;0,&nbsp;-1</spanx></c>
2793  <c>8</c> <c><spanx style="vbare">-1,&nbsp;&nbsp;0,&nbsp;&nbsp;1,&nbsp;&nbsp;2</spanx></c>
2794  <c>9</c> <c><spanx style="vbare">&nbsp;1,&nbsp;&nbsp;0,&nbsp;&nbsp;0,&nbsp;-1</spanx></c>
2795 <c>10</c> <c><spanx style="vbare">-2,&nbsp;-1,&nbsp;&nbsp;1,&nbsp;&nbsp;2</spanx></c>
2796 <c>11</c> <c><spanx style="vbare">&nbsp;2,&nbsp;&nbsp;1,&nbsp;&nbsp;0,&nbsp;-1</spanx></c>
2797 <c>12</c> <c><spanx style="vbare">-2,&nbsp;&nbsp;0,&nbsp;&nbsp;0,&nbsp;&nbsp;2</spanx></c>
2798 <c>13</c> <c><spanx style="vbare">-2,&nbsp;&nbsp;0,&nbsp;&nbsp;1,&nbsp;&nbsp;3</spanx></c>
2799 <c>14</c> <c><spanx style="vbare">&nbsp;2,&nbsp;&nbsp;1,&nbsp;-1,&nbsp;-2</spanx></c>
2800 <c>15</c> <c><spanx style="vbare">-3,&nbsp;-1,&nbsp;&nbsp;1,&nbsp;&nbsp;3</spanx></c>
2801 <c>16</c> <c><spanx style="vbare">&nbsp;2,&nbsp;&nbsp;0,&nbsp;&nbsp;0,&nbsp;-2</spanx></c>
2802 <c>17</c> <c><spanx style="vbare">&nbsp;3,&nbsp;&nbsp;1,&nbsp;&nbsp;0,&nbsp;-2</spanx></c>
2803 <c>18</c> <c><spanx style="vbare">-3,&nbsp;-1,&nbsp;&nbsp;2,&nbsp;&nbsp;4</spanx></c>
2804 <c>19</c> <c><spanx style="vbare">-4,&nbsp;-1,&nbsp;&nbsp;1,&nbsp;&nbsp;4</spanx></c>
2805 <c>20</c> <c><spanx style="vbare">&nbsp;3,&nbsp;&nbsp;1,&nbsp;-1,&nbsp;-3</spanx></c>
2806 <c>21</c> <c><spanx style="vbare">-4,&nbsp;-1,&nbsp;&nbsp;2,&nbsp;&nbsp;5</spanx></c>
2807 <c>22</c> <c><spanx style="vbare">&nbsp;4,&nbsp;&nbsp;2,&nbsp;-1,&nbsp;-3</spanx></c>
2808 <c>23</c> <c><spanx style="vbare">&nbsp;4,&nbsp;&nbsp;1,&nbsp;-1,&nbsp;-4</spanx></c>
2809 <c>24</c> <c><spanx style="vbare">-5,&nbsp;-1,&nbsp;&nbsp;2,&nbsp;&nbsp;6</spanx></c>
2810 <c>25</c> <c><spanx style="vbare">&nbsp;5,&nbsp;&nbsp;2,&nbsp;-1,&nbsp;-4</spanx></c>
2811 <c>26</c> <c><spanx style="vbare">-6,&nbsp;-2,&nbsp;&nbsp;2,&nbsp;&nbsp;6</spanx></c>
2812 <c>27</c> <c><spanx style="vbare">-5,&nbsp;-2,&nbsp;&nbsp;2,&nbsp;&nbsp;5</spanx></c>
2813 <c>28</c> <c><spanx style="vbare">&nbsp;6,&nbsp;&nbsp;2,&nbsp;-1,&nbsp;-5</spanx></c>
2814 <c>29</c> <c><spanx style="vbare">-7,&nbsp;-2,&nbsp;&nbsp;3,&nbsp;&nbsp;8</spanx></c>
2815 <c>30</c> <c><spanx style="vbare">&nbsp;6,&nbsp;&nbsp;2,&nbsp;-2,&nbsp;-6</spanx></c>
2816 <c>31</c> <c><spanx style="vbare">&nbsp;5,&nbsp;&nbsp;2,&nbsp;-2,&nbsp;-5</spanx></c>
2817 <c>32</c> <c><spanx style="vbare">&nbsp;8,&nbsp;&nbsp;3,&nbsp;-2,&nbsp;-7</spanx></c>
2818 <c>33</c> <c><spanx style="vbare">-9,&nbsp;-3,&nbsp;&nbsp;3,&nbsp;&nbsp;9</spanx></c>
2819 </texttable>
2820
2821 <t>
2822 The final pitch lag for each subframe is assembled in silk_decode_pitch()
2823  (silk_decode_pitch.c).
2824 Let lag be the primary pitch lag for the current SILK frame, contour_index be
2825  index of the VQ codebook, and lag_cb[contour_index][k] be the corresponding
2826  entry of the codebook from the appropriate table given above for the
2827  <spanx style="emph">k</spanx>th subframe.
2828 Then the final pitch lag for that subframe is
2829 <figure align="center">
2830 <artwork align="center"><![CDATA[
2831 pitch_lags[k] = clamp(lag_min, lag + lag_cb[contour_index][k],
2832                       lag_max)
2833 ]]></artwork>
2834 </figure>
2835  where lag_min and lag_max are the values from the "Minimum Lag" and
2836  "Maximum Lag" columns of <xref target="silk_abs_pitch_low_pdf"/>,
2837  respectively.
2838 </t>
2839
2840 </section>
2841
2842 </section>
2843
2844 </section>
2845
2846 <section title="LBRR Frames">
2847 <t>
2848 LBRR frames, if present, immediately follow the header bits, prior to any
2849  regular SILK frames.
2850 Each frame whose LBRR flag was set includes a separate set of data for each
2851  channel.
2852 </t>
2853 </section>
2854
2855 </section>
2856
2857
2858 <section title="CELT Decoder">
2859
2860 <!--TODO: t>
2861 Insert decoder figure.
2862
2863 </t-->
2864
2865 <texttable anchor='table_example'>
2866 <ttcol align='center'>Symbol(s)</ttcol>
2867 <ttcol align='center'>PDF</ttcol>
2868 <ttcol align='center'>Condition</ttcol>
2869 <c>silence</c>      <c>{32767, 1}/32768</c> <c></c>
2870 <c>post-filter</c>  <c>{1, 1}/2</c> <c></c>
2871 <c>octave</c>       <c>uniform (6)</c><c>post-filter</c>
2872 <c>period</c>       <c>raw bits (4+octave)</c><c>post-filter</c>
2873 <c>gain</c>         <c>raw bits (3)</c><c>post-filter</c>
2874 <c>tapset</c>       <c>{2, 1, 1}/4</c><c>post-filter</c>
2875 <c>transient</c>    <c>{7, 1}/8</c><c></c>
2876 <c>intra</c>        <c>{7, 1}/8</c><c></c>
2877 <c>coarse energy</c><c><xref target="energy-decoding"/></c><c></c>
2878 <c>tf_change</c>    <c><xref target="transient-decoding"/></c><c></c>
2879 <c>tf_select</c>    <c>{1, 1}/2</c><c><xref target="transient-decoding"/></c>
2880 <c>spread</c>       <c>{7, 2, 21, 2}/32</c><c></c>
2881 <c>dyn. alloc.</c>  <c><xref target="allocation"/></c><c></c>
2882 <c>alloc. trim</c>  <c>{2, 2, 5, 10, 22, 46, 22, 10, 5, 2, 2}/128</c><c></c>
2883 <c>skip</c>         <c>{1, 1}/2</c><c><xref target="allocation"/></c>
2884 <c>intensity</c>    <c>uniform</c><c><xref target="allocation"/></c>
2885 <c>dual</c>         <c>{1, 1}/2</c><c></c>
2886 <c>fine energy</c>  <c><xref target="energy-decoding"/></c><c></c>
2887 <c>residual</c>     <c><xref target="PVQ-decoder"/></c><c></c>
2888 <c>anti-collapse</c><c>{1, 1}/2</c><c><xref target="anti-collapse"/></c>
2889 <c>finalize</c>     <c><xref target="energy-decoding"/></c><c></c>
2890 <postamble>Order of the symbols in the CELT section of the bit-stream.</postamble>
2891 </texttable>
2892
2893 <t>
2894 The decoder extracts information from the range-coded bit-stream in the order
2895 described in the figure above. In some circumstances, it is
2896 possible for a decoded value to be out of range due to a very small amount of redundancy
2897 in the encoding of large integers by the range coder.
2898 In that case, the decoder should assume there has been an error in the coding,
2899 decoding, or transmission and SHOULD take measures to conceal the error and/or report
2900 to the application that a problem has occurred.
2901 </t>
2902
2903 <section anchor="transient-decoding" title="Transient Decoding">
2904 <t>
2905 The <spanx style="emph">transient</spanx> flag encoded in the bit-stream has a
2906 probability of 1/8. When it is set, then the MDCT coefficients represent multiple
2907 short MDCTs in the frame. When not set, the coefficients represent a single
2908 long MDCT for the frame. In addition to the global transient flag is a per-band
2909 binary flag to change the time-frequency (tf) resolution independently in each band. The
2910 change in tf resolution is defined in tf_select_table[][] in celt.c and depends
2911 on the frame size, whether the transient flag is set, and the value of tf_select.
2912 The tf_select flag uses a 1/2 probability, but is only decoded
2913 if it can have an impact on the result knowing the value of all per-band
2914 tf_change flags.
2915 </t>
2916 </section>
2917
2918 <section anchor="energy-decoding" title="Energy Envelope Decoding">
2919
2920 <t>
2921 It is important to quantize the energy with sufficient resolution because
2922 any energy quantization error cannot be compensated for at a later
2923 stage. Regardless of the resolution used for encoding the shape of a band,
2924 it is perceptually important to preserve the energy in each band. CELT uses a
2925 three-step coarse-fine-fine strategy for encoding the energy in the base-2 log
2926 domain, as implemented in quant_bands.c</t>
2927
2928 <section anchor="coarse-energy-decoding" title="Coarse energy decoding">
2929 <t>
2930 Coarse quantization of the energy uses a fixed resolution of 6 dB
2931 (integer part of base-2 log). To minimize the bitrate, prediction is applied
2932 both in time (using the previous frame) and in frequency (using the previous
2933 bands). The part of the prediction that is based on the
2934 previous frame can be disabled, creating an "intra" frame where the energy
2935 is coded without reference to prior frames. The decoder first reads the intra flag
2936 to determine what prediction is used.
2937 The 2-D z-transform of
2938 the prediction filter is: A(z_l, z_b)=(1-a*z_l^-1)*(1-z_b^-1)/(1-b*z_b^-1)
2939 where b is the band index and l is the frame index. The prediction coefficients
2940 applied depend on the frame size in use when not using intra energy and a=0 b=4915/32768
2941 when using intra energy.
2942 The time-domain prediction is based on the final fine quantization of the previous
2943 frame, while the frequency domain (within the current frame) prediction is based
2944 on coarse quantization only (because the fine quantization has not been computed
2945 yet). The prediction is clamped internally so that fixed point implementations with
2946 limited dynamic range to not suffer desynchronization.
2947 We approximate the ideal
2948 probability distribution of the prediction error using a Laplace distribution
2949 with seperate parameters for each frame size in intra and inter-frame modes. The
2950 coarse energy quantization is performed by unquant_coarse_energy() and
2951 unquant_coarse_energy_impl() (quant_bands.c). The encoding of the Laplace-distributed values is
2952 implemented in ec_laplace_decode() (laplace.c).
2953 </t>
2954
2955 </section>
2956
2957 <section anchor="fine-energy-decoding" title="Fine energy quantization">
2958 <t>
2959 The number of bits assigned to fine energy quantization in each band is determined
2960 by the bit allocation computation described in <xref target="allocation"></xref>.
2961 Let B_i be the number of fine energy bits
2962 for band i; the refinement is an integer f in the range [0,2^B_i-1]. The mapping between f
2963 and the correction applied to the coarse energy is equal to (f+1/2)/2^B_i - 1/2. Fine
2964 energy quantization is implemented in quant_fine_energy() (quant_bands.c).
2965 </t>
2966 <t>
2967 When some bits are left "unused" after all other flags have been decoded, these bits
2968 are assigned to a "final" step of fine allocation. In effect, these bits are used
2969 to add one extra fine energy bit per band per channel. The allocation process
2970 determines two <spanx style="emph">priorities</spanx> for the final fine bits.
2971 Any remaining bits are first assigned only to bands of priority 0, starting
2972 from band 0 and going up. If all bands of priority 0 have received one bit per
2973 channel, then bands of priority 1 are assigned an extra bit per channel,
2974 starting from band 0. If any bit is left after this, they are left unused.
2975 This is implemented in unquant_energy_finalise() (quant_bands.c).
2976 </t>
2977
2978 </section> <!-- fine energy -->
2979
2980 </section> <!-- Energy decode -->
2981
2982 <section anchor="allocation" title="Bit allocation">
2983 <t>Many codecs transmit significant amounts of side information for
2984 the purpose of controlling bit allocation within a frame. Often this
2985 side information controls bit usage indirectly and must be carefully
2986 selected to achieve the desired rate constraints.</t>
2987
2988 <t>The band-energy normalized structure of Opus MDCT mode ensures that a
2989 constant bit allocation for the shape content of a band will result in a
2990 roughly constant tone to noise ratio, which provides for fairly consistent
2991 perceptual performance. The effectiveness of this approach is the result of
2992 two factors: The band energy, which is understood to be perceptually
2993 important on its own, is always preserved regardless of the shape precision and because
2994 the constant tone-to-noise ratio implies a constant intra-band noise to masking ratio.
2995 Intra-band masking is the strongest of the perceptual masking effects. This structure
2996 means that the ideal allocation is more consistent from frame to frame than
2997 it is for other codecs without an equivalent structure.</t>
2998
2999 <t>Because the bit allocation is used to drive the decoding of the range-coder
3000 stream it MUST be recovered exactly so that identical coding decisions are
3001 made in the encoder and decoder. Any deviation from the reference's resulting
3002 bit allocation will result in corrupted output, though implementers are
3003 free to implement the procedure in any way which produces identical results.</t>
3004
3005 <t>Because all of the information required to decode a frame must be derived
3006 from that frame alone in order to retain robustness to packet loss the
3007 overhead of explicitly signaling the allocation would be considerable,
3008 especially for low-latency (small frame size) applications,
3009 even though the allocation is relatively static.</t>
3010
3011 <t>For this reason, in the MDCT mode Opus uses a primarily implicit bit
3012 allocation. The available bit-stream capacity is known in advance to both
3013 the encoder and decoder without additional signaling, ultimately from the
3014 packet sizes expressed by a higher level protocol. Using this information
3015 the codec interpolates an allocation from a hard-coded table.</t>
3016
3017 <t>While the band-energy structure effectively models intra-band masking,
3018 it ignores the weaker inter-band masking, band-temporal masking, and
3019 other less significant perceptual effects. While these effects can
3020 often be ignored they can become significant for particular samples. One
3021 mechanism available to encoders would be to simply increase the overall
3022 rate for these frames, but this is not possible in a constant rate mode
3023 and can be fairly inefficient. As a result three explicitly signaled
3024 mechanisms are provided to alter the implicit allocation:</t>
3025
3026 <t>
3027 <list style="symbols">
3028 <t>Band boost</t>
3029 <t>Allocation trim</t>
3030 <t>band skipping</t>
3031 </list>
3032 </t>
3033
3034 <t>The first of these mechanisms, band boost, allows an encoder to boost
3035 the allocation in specific bands. The second, allocation trim, works by
3036 biasing the overall allocation towards higher or lower frequency bands. The third, band
3037 skipping, selects which low-precision high frequency bands
3038 will be allocated no shape bits at all.</t>
3039
3040 <t>In stereo mode there are also two additional parameters
3041 potentially coded as part of the allocation procedure: a parameter to allow the
3042 selective elimination of allocation for the 'side' in jointly coded bands,
3043 and a flag to deactivate joint coding. These values are not signaled if
3044 they would be meaningless in the overall context of the allocation.</t>
3045
3046 <t>Because every signaled adjustment increases overhead and implementation
3047 complexity none were included speculatively: The reference encoder makes use
3048 of all of these mechanisms. While the decision logic in the reference was
3049 found to be effective enough to justify the overhead and complexity further
3050 analysis techniques may be discovered which increase the effectiveness of these
3051 parameters. As with other signaled parameters, encoder is free to choose the
3052 values in any manner but unless a technique is known to deliver superior
3053 perceptual results the methods used by the reference implementation should be
3054 used.</t>
3055
3056 <t>The process of allocation consists of the following steps: determining the per-band
3057 maximum allocation vector, decoding the boosts, decoding the tilt, determining
3058 the remaining capacity the frame, searching the mode table for the
3059 entry nearest but not exceeding the available space (subject to the tilt, boosts, band
3060 maximums, and band minimums), linear interpolation, reallocation of
3061 unused bits with concurrent skip decoding, determination of the
3062 fine-energy vs shape split, and final reallocation. This process results
3063 in an shape allocation per-band (in 1/8th bit units), a per-band fine-energy
3064 allocation (in 1 bit per channel units), a set of band priorities for
3065 controlling the use of remaining bits at the end of the frame, and a
3066 remaining balance of unallocated space which is usually zero except
3067 at very high rates.</t>
3068
3069 <t>The maximum allocation vector is an approximation of the maximum space
3070 which can be used by each band for a given mode. The value is
3071 approximate because the shape encoding is variable rate (due
3072 to entropy coding of splitting parameters). Setting the maximum too low reduces the
3073 maximum achievable quality in a band while setting it too high
3074 may result in waste: bit-stream capacity available at the end
3075 of the frame which can not be put to any use. The maximums
3076 specified by the codec reflect the average maximum. In the reference
3077 the maximums are provided partially computed form, in order to fit in less
3078 memory, as a static table (XXX cache.caps). Implementations are expected
3079 to simply use the same table data but the procedure for generating
3080 this table is included in rate.c as part of compute_pulse_cache().</t>
3081
3082 <t>To convert the values in cache.caps into the actual maximums: First
3083 set nbBands to the maximum number of bands for this mode and stereo to
3084 zero if stereo is not in use and one otherwise. For each band assign N
3085 to the number of MDCT bins covered by the band (for one channel), set LM
3086 to the shift value for the frame size (e.g. 0 for 120, 1 for 240, 3 for 480)
3087 then set i to nbBands*(2*LM+stereo). Then set the maximum for the band to
3088 the i-th index of cache.caps + 64 and multiply by the number of channels
3089 in the current frame (one or two) and by N then divide the result by 4
3090 using truncating integer division. The resulting vector will be called
3091 cap[]. The elements fit in signed 16 bit integers but do not fit in 8 bits.
3092 This procedure is implemented in the reference in the function init_caps() in celt.c.
3093 </t>
3094
3095 <t>The band boosts are represented by a series of binary symbols which
3096 are coded with very low probability. Each band can potentially be boosted
3097 multiple times, subject to the frame actually having enough room to obey
3098 the boost and having enough room to code the boost symbol. The default
3099 coding cost for a boost starts out at six bits, but subsequent boosts
3100 in a band cost only a single bit and every time a band is boosted the
3101 initial cost is reduced (down to a minimum of two). Since the initial
3102 cost of coding a boost is 6 bits the coding cost of the boost symbols when
3103 completely unused is 0.48 bits/frame for a 21 band mode (21*-log2(1-1/2^6)).</t>
3104
3105 <t>To decode the band boosts: First set 'dynalloc_logp' to 6, the initial
3106 amount of storage required to signal a boost in bits, 'total_bits' to the
3107 size of the frame in 8th-bits, 'total_boost' to zero, and 'tell' to the total number
3108 of 8th bits decoded
3109 so far. For each band from the coding start (0 normally, but 17 in hybrid mode)
3110 to the coding end (which changes depending on the signaled bandwidth): Set 'width'
3111 to the number of MDCT bins in this band for all channels. Take the larger of width
3112 and 64, then the minimum of that value and the width times eight and set 'quanta'
3113 to the result. This represents a boost step size of six bits subject to limits
3114 of 1/bit/sample and 1/8th bit/sample. Set 'boost' to zero and 'dynalloc_loop_logp'
3115 to dynalloc_logp. While dynalloc_loop_log (the current worst case symbol cost) in
3116 8th bits plus tell is less than total_bits plus total_boost and boost is less than cap[] for this
3117 band: Decode a bit from the bitstream with a with dynalloc_loop_logp as the cost
3118 of a one, update tell to reflect the current used capacity, if the decoded value
3119 is zero break the  loop otherwise add quanta to boost and total_boost, subtract quanta from
3120 total_bits, and set dynalloc_loop_log to 1. When the while loop finishes
3121 boost contains the boost for this band. If boost is non-zero and dynalloc_logp
3122 is greater than 2 decrease dynalloc_logp.  Once this process has been
3123 execute on all bands the band boosts have been decoded. This procedure
3124 is implemented around line 2352 of celt.c.</t>
3125
3126 <t>At very low rates it's possible that there won't be enough available
3127 space to execute the inner loop even once. In these cases band boost
3128 is not possible but its overhead is completely eliminated. Because of the
3129 high cost of band boost when activated a reasonable encoder should not be
3130 using it at very low rates. The reference implements its dynalloc decision
3131 logic at around 1269 of celt.c</t>
3132
3133 <t>The allocation trim is a integer value from 0-10. The default value of
3134 5 indicates no trim. The trim parameter is entropy coded in order to
3135 lower the coding cost of less extreme adjustments. Values lower than
3136 5 bias the allocation towards lower frequencies and values above 5
3137 bias it towards higher frequencies. Like other signaled parameters, signaling
3138 of the trim is gated so that it is not included if there is insufficient space
3139 available in the bitstream. To decode the trim first set
3140 the trim value to 5 then iff the count of decoded 8th bits so far (ec_tell_frac)
3141 plus 48 (6 bits) is less than or equal to the total frame size in 8th
3142 bits minus total_boost (a product of the above band boost procedure) then
3143 decode the trim value using the inverse CDF {127, 126, 124, 119, 109, 87, 41, 19, 9, 4, 2, 0}.</t>
3144
3145 <t>Stereo parameters</t>
3146
3147 <t>Anti-collapse reservation</t>
3148
3149 <t>The allocation computation first begins by setting up some initial conditions.
3150 'total' is set to the available remaining 8th bits, computed by taking the
3151 size of the coded frame times 8 and subtracting ec_tell_frac(). From this value one (8th bit)
3152 is subtracted to assure that the resulting allocation will be conservative. 'anti_collapse_rsv'
3153 is set to 8 (8th bits) iff the frame is a transient, LM is greater than 1, and total is
3154 greater than or equal to (LM+2) * 8. Total is then decremented by anti_collapse_rsv and clamped
3155 to be equal to or greater than zero. 'skip_rsv' is set to 8 (8th bits) if total is greater than
3156 8, otherwise it is zero. Total is then decremented by skip_rsv. This reserves space for the
3157 final skipping flag.</t>
3158
3159 <t>If the current frame is stereo intensity_rsv is set to the conservative log2 in 8th bits
3160 of the number of coded bands for this frame (given by the table LOG2_FRAC_TABLE). If
3161 intensity_rsv is greater than total then intensity_rsv is set to zero otherwise total is
3162 decremented by intensity_rsv, and if total is still greater than 8 dual_stereo_rsv is
3163 set to 8 and total is decremented by dual_stereo_rsv.</t>
3164
3165 <t>The allocation process then computes a vector representing the hard minimum amounts allocation
3166 any band will receive for shape. This minimum is higher than the technical limit of the PVQ
3167 process, but very low rate allocations produce excessively an sparse spectrum and these bands
3168 are better served by having no allocation at all. For each coded band set thresh[band] to
3169 twenty-four times the number of MDCT bins in the band and divide by 16. If 8 times the number
3170 of channels is greater, use that instead. This sets the minimum allocation to one bit per channel
3171 or 48 128th bits per MDCT bin, whichever is greater. The band size dependent part of this
3172 value is not scaled by the channel count because at the very low rates where this limit is
3173 applicable there will usually be no bits allocated to the side.</t>
3174
3175 <t>The previously decoded allocation trim is used to derive a vector of per-band adjustments,
3176 'trim_offsets[]'. For each coded band take the alloc_trim and subtract 5 and LM then multiply
3177 the result by number of channels, the number MDCT bins in the shortest frame size for this mode,
3178 the number remaining bands, 2^LM, and 8. Then divide this value by 64. Finally, if the
3179 number of MDCT bins in the band per channel is only one 8 times the number of channels is subtracted
3180 in order to diminish the allocation by one bit because width 1 bands receive greater benefit
3181 from the coarse energy coding.</t>
3182
3183
3184 </section>
3185
3186 <section anchor="PVQ-decoder" title="Shape Decoder">
3187 <t>
3188 In each band, the normalized <spanx style="emph">shape</spanx> is encoded
3189 using a vector quantization scheme called a "Pyramid vector quantizer".
3190 </t>
3191
3192 <t>In
3193 the simplest case, the number of bits allocated in
3194 <xref target="allocation"></xref> is converted to a number of pulses as described
3195 by <xref target="bits-pulses"></xref>. Knowing the number of pulses and the
3196 number of samples in the band, the decoder calculates the size of the codebook
3197 as detailed in <xref target="cwrs-decoder"></xref>. The size is used to decode
3198 an unsigned integer (uniform probability model), which is the codeword index.
3199 This index is converted into the corresponding vector as explained in
3200 <xref target="cwrs-decoder"></xref>. This vector is then scaled to unit norm.
3201 </t>
3202
3203 <section anchor="bits-pulses" title="Bits to Pulses">
3204 <t>
3205 Although the allocation is performed in 1/8th bit units, the quantization requires
3206 an integer number of pulses K. To do this, the encoder searches for the value
3207 of K that produces the number of bits that is the nearest to the allocated value
3208 (rounding down if exactly half-way between two values), subject to not exceeding
3209 the total number of bits available. For efficiency reasons the search is performed against a
3210 precomputated allocation table which only permits some K values for each N. The number of
3211 codebooks entries can be computed as explained in <xref target="cwrs-encoding"></xref>. The difference
3212 between the number of bits allocated and the number of bits used is accumulated to a
3213 <spanx style="emph">balance</spanx> (initialised to zero) that helps adjusting the
3214 allocation for the next bands. One third of the balance is applied to the
3215 bit allocation of the each band to help achieving the target allocation. The only
3216 exceptions are the band before the last and the last band, for which half the balance
3217 and the whole balance are applied, respectively.
3218 </t>
3219 </section>
3220
3221 <section anchor="cwrs-decoder" title="Index Decoding">
3222
3223 <t>
3224 The codeword is decoded as a uniformly-distributed integer value
3225 by decode_pulses() (cwrs.c).
3226 The codeword is converted from a unique index in the same way as specified in
3227 <xref target="PVQ"></xref>. The indexing is based on the calculation of V(N,K)
3228 (denoted N(L,K) in <xref target="PVQ"></xref>), which is the number of possible
3229 combinations of K pulses
3230 in N samples. The number of combinations can be computed recursively as
3231 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.
3232 There are many different ways to compute V(N,K), including pre-computed tables and direct
3233 use of the recursive formulation. The reference implementation applies the recursive
3234 formulation one line (or column) at a time to save on memory use,
3235 along with an alternate,
3236 univariate recurrence to initialise an arbitrary line, and direct
3237 polynomial solutions for small N. All of these methods are
3238 equivalent, and have different trade-offs in speed, memory usage, and
3239 code size. Implementations MAY use any methods they like, as long as
3240 they are equivalent to the mathematical definition.
3241 </t>
3242
3243 <t>
3244 The decoding of the codeword from the index is performed as specified in
3245 <xref target="PVQ"></xref>, as implemented in function
3246 decode_pulses() (cwrs.c).
3247 </t>
3248 </section>
3249
3250 <section anchor="spreading" title="Spreading">
3251 <t>
3252 </t>
3253 </section>
3254
3255 <section anchor="split" title="Split decoding">
3256 <t>
3257 To avoid the need for multi-precision calculations when decoding PVQ codevectors,
3258 the maximum size allowed for codebooks is 32 bits. When larger codebooks are
3259 needed, the vector is instead split in two sub-vectors of size N/2.
3260 A quantized gain parameter with precision
3261 derived from the current allocation is entropy coded to represent the relative
3262 gains of each side of the split and the entire decoding process is recursively
3263 applied. Multiple levels of splitting may be applied up to a frame size
3264 dependent limit. The same recursive mechanism is applied for the joint coding
3265 of stereo audio.
3266 </t>
3267
3268 </section>
3269
3270 <section anchor="tf-change" title="Time-Frequency change">
3271 <t>
3272 </t>
3273 </section>
3274
3275
3276 </section>
3277
3278 <section anchor="anti-collapse" title="Anti-collapse processing">
3279 <t>
3280 When the frame has the transient bit set, an anti-collapse bit is decoded.
3281 When anti-collapse is set, then the energy in each small MDCT is prevented
3282 from collapsing to zero. For each band of each MDCT where a collapse is
3283 detected, a pseudo-random signal is inserted with an energy corresponding
3284 to the min energy over the two previous frames. A renormalization step is
3285 then required to ensure that the anti-collapse step did not alter the
3286 energy preservation property.
3287 </t>
3288 </section>
3289
3290 <section anchor="denormalization" title="Denormalization">
3291 <t>
3292 Just like each band was normalized in the encoder, the last step of the decoder before
3293 the inverse MDCT is to denormalize the bands. Each decoded normalized band is
3294 multiplied by the square root of the decoded energy. This is done by denormalise_bands()
3295 (bands.c).
3296 </t>
3297 </section>
3298
3299 <section anchor="inverse-mdct" title="Inverse MDCT">
3300 <t>The inverse MDCT implementation has no special characteristics. The
3301 input is N frequency-domain samples and the output is 2*N time-domain
3302 samples, while scaling by 1/2. The output is windowed using the same window
3303 as the encoder. The IMDCT and windowing are performed by mdct_backward
3304 (mdct.c). If a time-domain pre-emphasis
3305 window was applied in the encoder, the (inverse) time-domain de-emphasis window
3306 is applied on the IMDCT result.
3307 </t>
3308
3309 <section anchor="post-filter" title="Post-filter">
3310 <t>
3311 The output of the inverse MDCT (after weighted overlap-add) is sent to the
3312 post-filter. Although the post-filter is applied at the end, the post-filter
3313 parameters are encoded at the beginning, just after the silence flag.
3314 The post-filter can be switched on or off using one bit (logp=1).
3315 If the post-filter is enabled, then the octave is decoded as an integer value
3316 between 0 and 6 of uniform probability. Once the octave is known, the fine pitch
3317 within the octave is decoded using 4+octave raw bits. The final pitch period
3318 is equal to (16&lt;&lt;octave)+fine_pitch-1 so it is bounded between 15 and 1022,
3319 inclusively. Next, the gain is decoded as three raw bits and is equal to
3320 G=3*(int_gain+1)/32. The set of post-filter taps is decoded last using
3321 a pdf equal to {2, 1, 1}/4. Tapset zero corresponds to the filter coefficients
3322 g0 = 0.3066406250, g1 = 0.2170410156, g2 = 0.1296386719. Tapset one
3323 corresponds to the filter coefficients g0 = 0.4638671875, g1 = 0.2680664062,
3324 g2 = 0, and tapset two uses filter coefficients g0 = 0.7998046875,
3325 g1 = 0.1000976562, g2 = 0.
3326 </t>
3327
3328 <t>
3329 The post-filter response is thus computed as:
3330               <figure align="center">
3331                 <artwork align="center">
3332                   <![CDATA[
3333    y(n) = x(n) + G*(g0*y(n-T) + g1*(y(n-T+1)+y(n-T+1))
3334                               + g2*(y(n-T+2)+y(n-T+2)))
3335 ]]>
3336                 </artwork>
3337               </figure>
3338
3339 During a transition between different gains, a smooth transition is calculated
3340 using the square of the MDCT window. It is important that values of y(n) be
3341 interpolated one at a time such that the past value of y(n) used is interpolated.
3342 </t>
3343 </section>
3344
3345 <section anchor="deemphasis" title="De-emphasis">
3346 <t>
3347 After the post-filter,
3348 the signal is de-emphasized using the inverse of the pre-emphasis filter
3349 used in the encoder: 1/A(z)=1/(1-alpha_p*z^-1), where alpha_p=0.8500061035.
3350 </t>
3351 </section>
3352
3353 </section>
3354
3355 <section anchor="Packet Loss Concealment" title="Packet Loss Concealment (PLC)">
3356 <t>
3357 Packet loss concealment (PLC) is an optional decoder-side feature which
3358 SHOULD be included when transmitting over an unreliable channel. Because
3359 PLC is not part of the bit-stream, there are several possible ways to
3360 implement PLC with different complexity/quality trade-offs. The PLC in
3361 the reference implementation finds a periodicity in the decoded
3362 signal and repeats the windowed waveform using the pitch offset. The windowed
3363 waveform is overlapped in such a way as to preserve the time-domain aliasing
3364 cancellation with the previous frame and the next frame. This is implemented
3365 in celt_decode_lost() (mdct.c).
3366 </t>
3367 </section>
3368
3369 </section>
3370
3371 <section anchor="switching" title="Mode Switching">
3372 <t>
3373 Switching between the Opus coding modes requires careful consideration. More
3374 specifically, the transitions that cannot be easily handled are the ones where
3375 the lower frequencies have to switch between the SILK LP-based model and the CELT
3376 transform model. If nothing is done, a glitch will occur for these transitions.
3377 On the other hand, switching between the SILK-only modes and the hybrid mode
3378 does not require any special treatment.
3379 </t>
3380
3381 <t>
3382 There are two ways to avoid or reduce glitches during the problematic mode 
3383 transitions: with, or without side information. Only transitions with side
3384 information are normatively specified. For transitions with no side
3385