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