9e3a281d8e07159bdfd78b73f1a489686f8faed8
[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-13">
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>Mozilla Corporation</organization>
13 <address>
14 <postal>
15 <street>650 Castro Street</street>
16 <city>Mountain View</city>
17 <region>CA</region>
18 <code>94041</code>
19 <country>USA</country>
20 </postal>
21 <phone>+1 650 903-0800</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>Soder Malarstrand 43</street>
31 <city>Stockholm</city>
32 <region></region>
33 <code>11825</code>
34 <country>SE</country>
35 </postal>
36 <phone>+46 73 085 7619</phone>
37 <email>koen.vos@skype.net</email>
38 </address>
39 </author>
40
41 <author initials="T." surname="Terriberry" fullname="Timothy B. 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="10" month="May" year="2012" />
57
58 <area>General</area>
59
60 <workgroup></workgroup>
61
62 <abstract>
63 <t>
64 This document defines the Opus interactive speech and audio codec.
65 Opus is designed to handle a wide range of interactive audio applications,
66  including Voice over IP, videoconferencing, in-game chat, and even live,
67  distributed music performances.
68 It scales from low bitrate narrowband speech at 6 kb/s to very high quality
69  stereo music at 510 kb/s.
70 Opus uses both linear prediction (LP) and the Modified Discrete Cosine
71  Transform (MDCT) to achieve good compression of both speech and music.
72 </t>
73 </abstract>
74 </front>
75
76 <middle>
77
78 <section anchor="introduction" title="Introduction">
79 <t>
80 The Opus codec is a real-time interactive audio codec designed to meet the requirements
81 described in <xref target="requirements"></xref>.
82 It is composed of a linear
83  prediction (LP)-based <xref target="LPC"/> layer and a Modified Discrete Cosine Transform
84  (MDCT)-based <xref target="MDCT"/> layer.
85 The main idea behind using two layers is that in speech, linear prediction
86  techniques (such as CELP) code low frequencies more efficiently than transform
87  (e.g., MDCT) domain techniques, while the situation is reversed for music and
88  higher speech frequencies.
89 Thus a codec with both layers available can operate over a wider range than
90  either one alone and, by combining them, achieve better quality than either
91  one individually.
92 </t>
93
94 <t>
95 The primary normative part of this specification is provided by the source code
96  in <xref target="ref-implementation"></xref>.
97 Only the decoder portion of this software is normative, though a
98  significant amount of code is shared by both the encoder and decoder.
99 <xref target="conformance"/> provides a decoder conformance test.
100 The decoder contains a great deal of integer and fixed-point arithmetic which
101  must be performed exactly, including all rounding considerations, so any
102  useful specification requires domain-specific symbolic language to adequately
103  define these operations.
104 Additionally, any
105 conflict between the symbolic representation and the included reference
106 implementation must be resolved. For the practical reasons of compatibility and
107 testability it would be advantageous to give the reference implementation
108 priority in any disagreement. The C language is also one of the most
109 widely understood human-readable symbolic representations for machine
110 behavior.
111 For these reasons this RFC uses the reference implementation as the sole
112  symbolic representation of the codec.
113 </t>
114
115 <t>While the symbolic representation is unambiguous and complete it is not
116 always the easiest way to understand the codec's operation. For this reason
117 this document also describes significant parts of the codec in English and
118 takes the opportunity to explain the rationale behind many of the more
119 surprising elements of the design. These descriptions are intended to be
120 accurate and informative, but the limitations of common English sometimes
121 result in ambiguity, so it is expected that the reader will always read
122 them alongside the symbolic representation. Numerous references to the
123 implementation are provided for this purpose. The descriptions sometimes
124 differ from the reference in ordering or through mathematical simplification
125 wherever such deviation makes an explanation easier to understand.
126 For example, the right shift and left shift operations in the reference
127 implementation are often described using division and multiplication in the text.
128 In general, the text is focused on the "what" and "why" while the symbolic
129 representation most clearly provides the "how".
130 </t>
131
132 <section anchor="notation" title="Notation and Conventions">
133 <t>
134 The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD",
135  "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be
136  interpreted as described in RFC 2119 <xref target="rfc2119"></xref>.
137 </t>
138 <t>
139 Even when using floating-point, various operations in the codec require
140  bit-exact fixed-point behavior.
141 The notation "Q&lt;n&gt;", where n is an integer, denotes the number of binary
142  digits to the right of the decimal point in a fixed-point number.
143 For example, a signed Q14 value in a 16-bit word can represent values from
144  -2.0 to 1.99993896484375, inclusive.
145 This notation is for informational purposes only.
146 Arithmetic, when described, always operates on the underlying integer.
147 E.g., the text will explicitly indicate any shifts required after a
148  multiplication.
149 </t>
150 <t>
151 Expressions, where included in the text, follow C operator rules and
152  precedence, with the exception that the syntax "x**y" indicates x raised to
153  the power y.
154 The text also makes use of the following functions:
155 </t>
156
157 <section anchor="min" toc="exclude" title="min(x,y)">
158 <t>
159 The smallest of two values x and y.
160 </t>
161 </section>
162
163 <section anchor="max" toc="exclude" title="max(x,y)">
164 <t>
165 The largest of two values x and y.
166 </t>
167 </section>
168
169 <section anchor="clamp" toc="exclude" title="clamp(lo,x,hi)">
170 <figure align="center">
171 <artwork align="center"><![CDATA[
172 clamp(lo,x,hi) = max(lo,min(x,hi))
173 ]]></artwork>
174 </figure>
175 <t>
176 With this definition, if lo&nbsp;&gt;&nbsp;hi, the lower bound is the one that
177  is enforced.
178 </t>
179 </section>
180
181 <section anchor="sign" toc="exclude" title="sign(x)">
182 <t>
183 The sign of x, i.e.,
184 <figure align="center">
185 <artwork align="center"><![CDATA[
186           ( -1,  x < 0 ,
187 sign(x) = <  0,  x == 0 ,
188           (  1,  x > 0 .
189 ]]></artwork>
190 </figure>
191 </t>
192 </section>
193
194 <section anchor="log2" toc="exclude" title="log2(f)">
195 <t>
196 The base-two logarithm of f.
197 </t>
198 </section>
199
200 <section anchor="ilog" toc="exclude" title="ilog(n)">
201 <t>
202 The minimum number of bits required to store a positive integer n in two's
203  complement notation, or 0 for a non-positive integer n.
204 <figure align="center">
205 <artwork align="center"><![CDATA[
206           ( 0,                 n <= 0,
207 ilog(n) = <
208           ( floor(log2(n))+1,  n > 0
209 ]]></artwork>
210 </figure>
211 Examples:
212 <list style="symbols">
213 <t>ilog(-1) = 0</t>
214 <t>ilog(0) = 0</t>
215 <t>ilog(1) = 1</t>
216 <t>ilog(2) = 2</t>
217 <t>ilog(3) = 2</t>
218 <t>ilog(4) = 3</t>
219 <t>ilog(7) = 3</t>
220 </list>
221 </t>
222 </section>
223
224 </section>
225
226 </section>
227
228 <section anchor="overview" title="Opus Codec Overview">
229
230 <t>
231 The Opus codec scales from 6&nbsp;kb/s narrowband mono speech to 510&nbsp;kb/s
232  fullband stereo music, with algorithmic delays ranging from 5&nbsp;ms to
233  65.2&nbsp;ms.
234 At any given time, either the LP layer, the MDCT layer, or both, may be active.
235 It can seamlessly switch between all of its various operating modes, giving it
236  a great deal of flexibility to adapt to varying content and network
237  conditions without renegotiating the current session.
238 The codec allows input and output of various audio bandwidths, defined as
239  follows:
240 </t>
241 <texttable anchor="audio-bandwidth">
242 <ttcol>Abbreviation</ttcol>
243 <ttcol align="right">Audio Bandwidth</ttcol>
244 <ttcol align="right">Sample Rate (Effective)</ttcol>
245 <c>NB (narrowband)</c>       <c>4&nbsp;kHz</c>  <c>8&nbsp;kHz</c>
246 <c>MB (medium-band)</c>      <c>6&nbsp;kHz</c> <c>12&nbsp;kHz</c>
247 <c>WB (wideband)</c>         <c>8&nbsp;kHz</c> <c>16&nbsp;kHz</c>
248 <c>SWB (super-wideband)</c> <c>12&nbsp;kHz</c> <c>24&nbsp;kHz</c>
249 <c>FB (fullband)</c>        <c>20&nbsp;kHz (*)</c> <c>48&nbsp;kHz</c>
250 </texttable>
251 <t>
252 (*) Although the sampling theorem allows a bandwidth as large as half the
253  sampling rate, Opus never codes audio above 20&nbsp;kHz, as that is the
254  generally accepted upper limit of human hearing.
255 </t>
256
257 <t>
258 Opus defines super-wideband (SWB) with an effective sample rate of 24&nbsp;kHz,
259  unlike some other audio coding standards that use 32&nbsp;kHz.
260 This was chosen for a number of reasons.
261 The band layout in the MDCT layer naturally allows skipping coefficients for
262  frequencies over 12&nbsp;kHz, but does not allow cleanly dropping just those
263  frequencies over 16&nbsp;kHz.
264 A sample rate of 24&nbsp;kHz also makes resampling in the MDCT layer easier,
265  as 24 evenly divides 48, and when 24&nbsp;kHz is sufficient, it can save
266  computation in other processing, such as Acoustic Echo Cancellation (AEC).
267 Experimental changes to the band layout to allow a 16&nbsp;kHz cutoff
268  (32&nbsp;kHz effective sample rate) showed potential quality degradations at
269  other sample rates, and at typical bitrates the number of bits saved by using
270  such a cutoff instead of coding in fullband (FB) mode is very small.
271 Therefore, if an application wishes to process a signal sampled at 32&nbsp;kHz,
272  it should just use FB.
273 </t>
274
275 <t>
276 The LP layer is based on the SILK codec
277  <xref target="SILK"></xref>.
278 It supports NB, MB, or WB audio and frame sizes from 10&nbsp;ms to 60&nbsp;ms,
279  and requires an additional 5&nbsp;ms look-ahead for noise shaping estimation.
280 A small additional delay (up to 1.5 ms) may be required for sampling rate
281  conversion.
282 Like Vorbis and many other modern codecs, SILK is inherently designed for
283  variable-bitrate (VBR) coding, though the encoder can also produce
284  constant-bitrate (CBR) streams.
285 The version of SILK used in Opus is substantially modified from, and not
286  compatible with, the stand-alone SILK codec previously deployed by Skype.
287 This document does not serve to define that format, but those interested in the
288  original SILK codec should see <xref target="SILK"/> instead.
289 </t>
290
291 <t>
292 The MDCT layer is based on the CELT  codec <xref target="CELT"></xref>.
293 It supports NB, WB, SWB, or FB audio and frame sizes from 2.5&nbsp;ms to
294  20&nbsp;ms, and requires an additional 2.5&nbsp;ms look-ahead due to the
295  overlapping MDCT windows.
296 The CELT codec is inherently designed for CBR coding, but unlike many CBR
297  codecs it is not limited to a set of predetermined rates.
298 It internally allocates bits to exactly fill any given target budget, and an
299  encoder can produce a VBR stream by varying the target on a per-frame basis.
300 The MDCT layer is not used for speech when the audio bandwidth is WB or less,
301  as it is not useful there.
302 On the other hand, non-speech signals are not always adequately coded using
303  linear prediction, so for music only the MDCT layer should be used.
304 </t>
305
306 <t>
307 A "Hybrid" mode allows the use of both layers simultaneously with a frame size
308  of 10&nbsp;or 20&nbsp;ms and a SWB or FB audio bandwidth.
309 Each frame is split into a low frequency signal and a high frequency signal,
310  with a cutoff of 8&nbsp;kHz.
311 The LP layer then codes the low frequency signal, followed by the MDCT layer
312  coding the high frequency signal.
313 In the MDCT layer, all bands below 8&nbsp;kHz are discarded, so there is no
314  coding redundancy between the two layers.
315 </t>
316
317 <t>
318 The sample rate (in contrast to the actual audio bandwidth) can be chosen
319  independently on the encoder and decoder side, e.g., a fullband signal can be
320  decoded as wideband, or vice versa.
321 This approach ensures a sender and receiver can always interoperate, regardless
322  of the capabilities of their actual audio hardware.
323 Internally, the LP layer always operates at a sample rate of twice the audio
324  bandwidth, up to a maximum of 16&nbsp;kHz, which it continues to use for SWB
325  and FB.
326 The decoder simply resamples its output to support different sample rates.
327 The MDCT layer always operates internally at a sample rate of 48&nbsp;kHz.
328 Since all the supported sample rates evenly divide this rate, and since the
329  the decoder may easily zero out the high frequency portion of the spectrum in
330  the frequency domain, it can simply decimate the MDCT layer output to achieve
331  the other supported sample rates very cheaply.
332 </t>
333
334 <t>
335 After conversion to the common, desired output sample rate, the decoder simply
336  adds the output from the two layers together.
337 To compensate for the different look-ahead required by each layer, the CELT
338  encoder input is delayed by an additional 2.7&nbsp;ms.
339 This ensures that low frequencies and high frequencies arrive at the same time.
340 This extra delay may be reduced by an encoder by using less look-ahead for noise
341  shaping or using a simpler resampler in the LP layer, but this will reduce
342  quality.
343 However, the base 2.5&nbsp;ms look-ahead in the CELT layer cannot be reduced in
344  the encoder because it is needed for the MDCT overlap, whose size is fixed by
345  the decoder.
346 </t>
347
348 <t>
349 Both layers use the same entropy coder, avoiding any waste from "padding bits"
350  between them.
351 The hybrid approach makes it easy to support both CBR and VBR coding.
352 Although the LP layer is VBR, the bit allocation of the MDCT layer can produce
353  a final stream that is CBR by using all the bits left unused by the LP layer.
354 </t>
355
356 <section title="Control Parameters">
357 <t>
358 The Opus codec includes a number of control parameters which can be changed dynamically during
359 regular operation of the codec, without interrupting the audio stream from the encoder to the decoder.
360 These parameters only affect the encoder since any impact they have on the bit-stream is signaled
361 in-band such that a decoder can decode any Opus stream without any out-of-band signaling. Any Opus
362 implementation can add or modify these control parameters without affecting interoperability. The most
363 important encoder control parameters in the reference encoder are listed below.
364 </t>
365
366 <section title="Bitrate" toc="exlcude">
367 <t>
368 Opus supports all bitrates from 6&nbsp;kb/s to 510&nbsp;kb/s. All other parameters being
369 equal, higher bitrate results in higher quality. For a frame size of 20&nbsp;ms, these
370 are the bitrate "sweet spots" for Opus in various configurations:
371 <list style="symbols">
372 <t>8-12 kb/s for NB speech,</t>
373 <t>16-20 kb/s for WB speech,</t>
374 <t>28-40 kb/s for FB speech,</t>
375 <t>48-64 kb/s for FB mono music, and</t>
376 <t>64-128 kb/s for FB stereo music.</t>
377 </list>
378 </t>
379 </section>
380
381 <section title="Number of Channels (Mono/Stereo)" toc="exlcude">
382 <t>
383 Opus can transmit either mono or stereo frames within a single stream.
384 When decoding a mono frame in a stereo decoder, the left and right channels are
385  identical, and when decoding a stereo frame in a mono decoder, the mono output
386  is the average of the left and right channels.
387 In some cases, it is desirable to encode a stereo input stream in mono (e.g.,
388  because the bitrate is too low to encode stereo with sufficient quality).
389 The number of channels encoded can be selected in real-time, but by default the
390  reference encoder attempts to make the best decision possible given the
391  current bitrate.
392 </t>
393 </section>
394
395 <section title="Audio Bandwidth" toc="exlcude">
396 <t>
397 The audio bandwidths supported by Opus are listed in
398  <xref target="audio-bandwidth"/>.
399 Just like for the number of channels, any decoder can decode audio encoded at
400  any bandwidth.
401 For example, any Opus decoder operating at 8&nbsp;kHz can decode a FB Opus
402  frame, and any Opus decoder operating at 48&nbsp;kHz can decode a NB frame.
403 Similarly, the reference encoder can take a 48&nbsp;kHz input signal and
404  encode it as NB.
405 The higher the audio bandwidth, the higher the required bitrate to achieve
406  acceptable quality.
407 The audio bandwidth can be explicitly specified in real-time, but by default
408  the reference encoder attempts to make the best bandwidth decision possible
409  given the current bitrate.
410 </t>
411 </section>
412
413
414 <section title="Frame Duration" toc="exlcude">
415 <t>
416 Opus can encode frames of 2.5, 5, 10, 20, 40 or 60&nbsp;ms.
417 It can also combine multiple frames into packets of up to 120&nbsp;ms.
418 For real-time applications, sending fewer packets per second reduces the
419  bitrate, since it reduces the overhead from IP, UDP, and RTP headers.
420 However, it increases latency and sensitivity to packet losses, as losing one
421  packet constitutes a loss of a bigger chunk of audio.
422 Increasing the frame duration also slightly improves coding efficiency, but the
423  gain becomes small for frame sizes above 20&nbsp;ms.
424 For this reason, 20&nbsp;ms frames are a good choice for most applications.
425 </t>
426 </section>
427
428 <section title="Complexity" toc="exlcude">
429 <t>
430 There are various aspects of the Opus encoding process where trade-offs
431 can be made between CPU complexity and quality/bitrate. In the reference
432 encoder, the complexity is selected using an integer from 0 to 10, where
433 0 is the lowest complexity and 10 is the highest. Examples of
434 computations for which such trade-offs may occur are:
435 <list style="symbols">
436 <t>The order of the pitch analysis whitening filter <xref target="Whitening"/>,</t>
437 <t>The order of the short-term noise shaping filter,</t>
438 <t>The number of states in delayed decision quantization of the
439 residual signal, and</t>
440 <t>The use of certain bit-stream features such as variable time-frequency
441 resolution and the pitch post-filter.</t>
442 </list>
443 </t>
444 </section>
445
446 <section title="Packet Loss Resilience" toc="exlcude">
447 <t>
448 Audio codecs often exploit inter-frame correlations to reduce the
449 bitrate at a cost in error propagation: after losing one packet
450 several packets need to be received before the decoder is able to
451 accurately reconstruct the speech signal.  The extent to which Opus
452 exploits inter-frame dependencies can be adjusted on the fly to
453 choose a trade-off between bitrate and amount of error propagation.
454 </t>
455 </section>
456
457 <section title="Forward Error Correction (FEC)" toc="exlcude">
458 <t>
459    Another mechanism providing robustness against packet loss is the in-band
460    Forward Error Correction (FEC).  Packets that are determined to
461    contain perceptually important speech information, such as onsets or
462    transients, are encoded again at a lower bitrate and this re-encoded
463    information is added to a subsequent packet.
464 </t>
465 </section>
466
467 <section title="Constant/Variable Bitrate" toc="exlcude">
468 <t>
469 Opus is more efficient when operating with variable bitrate (VBR), which is
470 the default. However, in some (rare) applications, constant bitrate (CBR)
471 is required. There are two main reasons to operate in CBR mode:
472 <list style="symbols">
473 <t>When the transport only supports a fixed size for each compressed frame</t>
474 <t>When encryption is used for an audio stream that is either highly constrained
475    (e.g. yes/no, recorded prompts) or highly sensitive <xref target="SRTP-VBR"></xref> </t>
476 </list>
477
478 When low-latency transmission is required over a relatively slow connection, then
479 constrained VBR can also be used. This uses VBR in a way that simulates a
480 "bit reservoir" and is equivalent to what MP3 and AAC call CBR (i.e. not true
481 CBR due to the bit reservoir).
482 </t>
483 </section>
484
485 <section title="Discontinuous Transmission (DTX)" toc="exlcude">
486 <t>
487    Discontinuous Transmission (DTX) reduces the bitrate during silence
488    or background noise.  When DTX is enabled, only one frame is encoded
489    every 400 milliseconds.
490 </t>
491 </section>
492
493 </section>
494
495 </section>
496
497 <section anchor="modes" title="Internal Framing">
498
499 <t>
500 The Opus encoder produces "packets", which are each a contiguous set of bytes
501  meant to be transmitted as a single unit.
502 The packets described here do not include such things as IP, UDP, or RTP
503  headers which are normally found in a transport-layer packet.
504 A single packet may contain multiple audio frames, so long as they share a
505  common set of parameters, including the operating mode, audio bandwidth, frame
506  size, and channel count (mono vs. stereo).
507 This section describes the possible combinations of these parameters and the
508  internal framing used to pack multiple frames into a single packet.
509 This framing is not self-delimiting.
510 Instead, it assumes that a higher layer (such as UDP or RTP or Ogg or Matroska)
511  will communicate the length, in bytes, of the packet, and it uses this
512  information to reduce the framing overhead in the packet itself.
513 A decoder implementation MUST support the framing described in this section.
514 An alternative, self-delimiting variant of the framing is described in
515  <xref target="self-delimiting-framing"/>.
516 Support for that variant is OPTIONAL.
517 </t>
518
519 <t>
520 All bit diagrams in this document number the bits so that bit 0 is the most
521  significant bit of the first byte, and bit 7 is the least significant.
522 Bit 8 is thus the most significant bit of the second byte, etc.
523 </t>
524
525 <section anchor="toc_byte" title="The TOC Byte">
526 <t>
527 An Opus packet begins with a single-byte table-of-contents (TOC) header that
528  signals which of the various modes and configurations a given packet uses.
529 It is composed of a configuration number, "config", a stereo flag, "s", and a
530  frame count code, "c", arranged as illustrated in
531  <xref target="toc_byte_fig"/>.
532 A description of each of these fields follows.
533 </t>
534
535 <figure anchor="toc_byte_fig" title="The TOC byte">
536 <artwork align="center"><![CDATA[
537  0
538  0 1 2 3 4 5 6 7
539 +-+-+-+-+-+-+-+-+
540 | config  |s| c |
541 +-+-+-+-+-+-+-+-+
542 ]]></artwork>
543 </figure>
544
545 <t>
546 The top five bits of the TOC byte, labeled "config", encode one of 32 possible
547  configurations of operating mode, audio bandwidth, and frame size.
548 As described, the LP layer and MDCT layer can be combined in three possible
549  operating modes:
550 <list style="numbers">
551 <t>An LP-only mode for use in low bitrate connections with an audio bandwidth
552  of WB or less,</t>
553 <t>A Hybrid (LP+MDCT) mode for SWB or FB speech at medium bitrates, and</t>
554 <t>An MDCT-only mode for very low delay speech transmission as well as music
555  transmission (NB to FB).</t>
556 </list>
557 The 32 possible configurations each identify which one of these operating modes
558  the packet uses, as well as the audio bandwidth and the frame size.
559 <xref target="config_bits"/> lists the parameters for each configuration.
560 </t>
561 <texttable anchor="config_bits" title="TOC Byte Configuration Parameters">
562 <ttcol>Configuration Number(s)</ttcol>
563 <ttcol>Mode</ttcol>
564 <ttcol>Bandwidth</ttcol>
565 <ttcol>Frame Sizes</ttcol>
566 <c>0...3</c>   <c>SILK-only</c> <c>NB</c>  <c>10, 20, 40, 60&nbsp;ms</c>
567 <c>4...7</c>   <c>SILK-only</c> <c>MB</c>  <c>10, 20, 40, 60&nbsp;ms</c>
568 <c>8...11</c>  <c>SILK-only</c> <c>WB</c>  <c>10, 20, 40, 60&nbsp;ms</c>
569 <c>12...13</c> <c>Hybrid</c>    <c>SWB</c> <c>10, 20&nbsp;ms</c>
570 <c>14...15</c> <c>Hybrid</c>    <c>FB</c>  <c>10, 20&nbsp;ms</c>
571 <c>16...19</c> <c>CELT-only</c> <c>NB</c>  <c>2.5, 5, 10, 20&nbsp;ms</c>
572 <c>20...23</c> <c>CELT-only</c> <c>WB</c>  <c>2.5, 5, 10, 20&nbsp;ms</c>
573 <c>24...27</c> <c>CELT-only</c> <c>SWB</c> <c>2.5, 5, 10, 20&nbsp;ms</c>
574 <c>28...31</c> <c>CELT-only</c> <c>FB</c>  <c>2.5, 5, 10, 20&nbsp;ms</c>
575 </texttable>
576 <t>
577 The configuration numbers in each range (e.g., 0...3 for NB SILK-only)
578  correspond to the various choices of frame size, in the same order.
579 For example, configuration 0 has a 10&nbsp;ms frame size and configuration 3
580  has a 60&nbsp;ms frame size.
581 </t>
582
583 <t>
584 One additional bit, labeled "s", signals mono vs. stereo, with 0 indicating
585  mono and 1 indicating stereo.
586 </t>
587
588 <t>
589 The remaining two bits of the TOC byte, labeled "c", code the number of frames
590  per packet (codes 0 to 3) as follows:
591 <list style="symbols">
592 <t>0:    1 frame in the packet</t>
593 <t>1:    2 frames in the packet, each with equal compressed size</t>
594 <t>2:    2 frames in the packet, with different compressed sizes</t>
595 <t>3:    an arbitrary number of frames in the packet</t>
596 </list>
597 This draft refers to a packet as a code 0 packet, code 1 packet, etc., based on
598  the value of "c".
599 </t>
600
601 <t>
602 A well-formed Opus packet MUST contain at least one byte with the TOC
603  information, though the frame(s) within a packet MAY be zero bytes long.
604 </t>
605 </section>
606
607 <section title="Frame Packing">
608
609 <t>
610 This section describes how frames are packed according to each possible value
611  of "c" in the TOC byte.
612 </t>
613
614 <section anchor="frame-length-coding" title="Frame Length Coding">
615 <t>
616 When a packet contains multiple VBR frames (i.e., code 2 or 3), the compressed
617  length of one or more of these frames is indicated with a one- or two-byte
618  sequence, with the meaning of the first byte as follows:
619 <list style="symbols">
620 <t>0:          No frame (discontinuous transmission (DTX) or lost packet)</t>
621 <t>1...251:    Length of the frame in bytes</t>
622 <t>252...255:  A second byte is needed. The total length is (len[1]*4)+len[0]</t>
623 </list>
624 </t>
625
626 <t>
627 The special length 0 indicates that no frame is available, either because it
628  was dropped during transmission by some intermediary or because the encoder
629  chose not to transmit it.
630 A length of 0 is valid for any Opus frame in any mode.
631 </t>
632
633 <t>
634 The maximum representable length is 255*4+255=1275&nbsp;bytes.
635 For 20&nbsp;ms frames, this represents a bitrate of 510&nbsp;kb/s, which is
636  approximately the highest useful rate for lossily compressed fullband stereo
637  music.
638 Beyond this point, lossless codecs are more appropriate.
639 It is also roughly the maximum useful rate of the MDCT layer, as shortly
640  thereafter quality no longer improves with additional bits due to limitations
641  on the codebook sizes.
642 </t>
643
644 <t>
645 No length is transmitted for the last frame in a VBR packet, or for any of the
646  frames in a CBR packet, as it can be inferred from the total size of the
647  packet and the size of all other data in the packet.
648 However, the length of any individual frame MUST NOT exceed 1275&nbsp;bytes, to
649  allow for repacketization by gateways, conference bridges, or other software.
650 </t>
651 </section>
652
653 <section title="Code 0: One Frame in the Packet">
654
655 <t>
656 For code&nbsp;0 packets, the TOC byte is immediately followed by N-1&nbsp;bytes
657  of compressed data for a single frame (where N is the size of the packet),
658  as illustrated in <xref target="code0_packet"/>.
659 </t>
660 <figure anchor="code0_packet" title="A Code 0 Packet" align="center">
661 <artwork align="center"><![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 | config  |s|0|0|                                               |
666 +-+-+-+-+-+-+-+-+                                               |
667 |                    Compressed frame 1 (N-1 bytes)...          :
668 :                                                               |
669 |                                                               |
670 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
671 ]]></artwork>
672 </figure>
673 </section>
674
675 <section title="Code 1: Two Frames in the Packet, Each with Equal Compressed Size">
676 <t>
677 For code 1 packets, the TOC byte is immediately followed by the
678  (N-1)/2&nbsp;bytes of compressed data for the first frame, followed by
679  (N-1)/2&nbsp;bytes of compressed data for the second frame, as illustrated in
680  <xref target="code1_packet"/>.
681 The number of payload bytes available for compressed data, N-1, MUST be even
682  for all code 1 packets.
683 </t>
684 <figure anchor="code1_packet" title="A Code 1 Packet" align="center">
685 <artwork align="center"><![CDATA[
686  0                   1                   2                   3
687  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
688 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
689 | config  |s|0|1|                                               |
690 +-+-+-+-+-+-+-+-+                                               :
691 |             Compressed frame 1 ((N-1)/2 bytes)...             |
692 :                               +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
693 |                               |                               |
694 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+                               :
695 |             Compressed frame 2 ((N-1)/2 bytes)...             |
696 :                                               +-+-+-+-+-+-+-+-+
697 |                                               |
698 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
699 ]]></artwork>
700 </figure>
701 </section>
702
703 <section title="Code 2: Two Frames in the Packet, with Different Compressed Sizes">
704 <t>
705 For code 2 packets, the TOC byte is followed by a one- or two-byte sequence
706  indicating the length of the first frame (marked N1 in the figure below),
707  followed by N1 bytes of compressed data for the first frame.
708 The remaining N-N1-2 or N-N1-3&nbsp;bytes are the compressed data for the
709  second frame.
710 This is illustrated in <xref target="code2_packet"/>.
711 A code 2 packet MUST contain enough bytes to represent a valid length.
712 For example, a 1-byte code 2 packet is always invalid, and a 2-byte code 2
713  packet whose second byte is in the range 252...255 is also invalid.
714 The length of the first frame, N1, MUST also be no larger than the size of the
715  payload remaining after decoding that length for all code 2 packets.
716 This makes, for example, a 2-byte code 2 packet with a second byte in the range
717  1...251 invalid as well (the only valid 2-byte code 2 packet is one where the
718  length of both frames is zero).
719 </t>
720 <figure anchor="code2_packet" title="A Code 2 Packet" align="center">
721 <artwork align="center"><![CDATA[
722  0                   1                   2                   3
723  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
724 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
725 | config  |s|1|0| N1 (1-2 bytes):                               |
726 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+                               :
727 |               Compressed frame 1 (N1 bytes)...                |
728 :                               +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
729 |                               |                               |
730 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+                               |
731 |                     Compressed frame 2...                     :
732 :                                                               |
733 |                                                               |
734 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
735 ]]></artwork>
736 </figure>
737 </section>
738
739 <section title="Code 3: A Signaled Number of Frames in the Packet">
740 <t>
741 Code 3 packets signal the number of frames, as well as additional
742  padding, called "Opus padding" to indicate that this padding is added at the
743  Opus layer, rather than at the transport layer.
744 Code 3 packets MUST have at least 2 bytes.
745 The TOC byte is followed by a byte encoding the number of frames in the packet
746  in bits 2 to 7 (marked "M" in the figure below), with bit 1 indicating whether
747  or not Opus padding is inserted (marked "p" in the figure below), and bit 0
748  indicating VBR (marked "v" in the figure below).
749 M MUST NOT be zero, and the audio duration contained within a packet MUST NOT
750  exceed 120&nbsp;ms.
751 This limits the maximum frame count for any frame size to 48 (for 2.5&nbsp;ms
752  frames), with lower limits for longer frame sizes.
753 <xref target="frame_count_byte"/> illustrates the layout of the frame count
754  byte.
755 </t>
756 <figure anchor="frame_count_byte" title="The frame count byte">
757 <artwork align="center"><![CDATA[
758  0
759  0 1 2 3 4 5 6 7
760 +-+-+-+-+-+-+-+-+
761 |v|p|     M     |
762 +-+-+-+-+-+-+-+-+
763 ]]></artwork>
764 </figure>
765 <t>
766 When Opus padding is used, the number of bytes of padding is encoded in the
767  bytes following the frame count byte.
768 Values from 0...254 indicate that 0...254&nbsp;bytes of padding are included,
769  in addition to the byte(s) used to indicate the size of the padding.
770 If the value is 255, then the size of the additional padding is 254&nbsp;bytes,
771  plus the padding value encoded in the next byte.
772 There MUST be at least one more byte in the packet in this case.
773 The additional padding bytes appear at the end of the packet, and MUST be set
774  to zero by the encoder to avoid creating a covert channel.
775 The decoder MUST accept any value for the padding bytes, however.
776 </t>
777 <t>
778 Although this encoding provides multiple ways to indicate a given number of
779  padding bytes, each uses a different number of bytes to indicate the padding
780  size, and thus will increase the total packet size by a different amount.
781 For example, to add 255 bytes to a packet, set the padding bit, p, to 1, insert
782  a single byte after the frame count byte with a value of 254, and append 254
783  padding bytes with the value zero to the end of the packet.
784 To add 256 bytes to a packet, set the padding bit to 1, insert two bytes after
785  the frame count byte with the values 255 and 0, respectively, and append 254
786  padding bytes with the value zero to the end of the packet.
787 By using the value 255 multiple times, it is possible to create a packet of any
788  specific, desired size.
789 Let P be the number of header bytes used to indicate the padding size plus the
790  total amount of padding bytes (i.e., the total number of bytes added to the
791  packet).
792 Then P MUST be no more than N-2.
793 </t>
794 <t>
795 In the CBR case, the compressed length of each frame in bytes is equal to the
796  number of remaining bytes in the packet after subtracting the (optional)
797  padding, (N-2-P), divided by M.
798 This number MUST be a non-negative integer multiple of M.
799 The compressed data for all M frames then follows, each of size
800  (N-2-P)/M&nbsp;bytes, as illustrated in <xref target="code3cbr_packet"/>.
801 </t>
802
803 <figure anchor="code3cbr_packet" title="A CBR Code 3 Packet" align="center">
804 <artwork align="center"><![CDATA[
805  0                   1                   2                   3
806  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
807 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
808 | config  |s|1|1|0|p|     M     |  Padding length (Optional)    :
809 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
810 |                                                               |
811 :            Compressed frame 1 ((N-2-P)/M bytes)...            :
812 |                                                               |
813 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
814 |                                                               |
815 :            Compressed frame 2 ((N-2-P)/M bytes)...            :
816 |                                                               |
817 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
818 |                                                               |
819 :                              ...                              :
820 |                                                               |
821 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
822 |                                                               |
823 :            Compressed frame M ((N-2-P)/M bytes)...            :
824 |                                                               |
825 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
826 :                  Opus Padding (Optional)...                   |
827 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
828 ]]></artwork>
829 </figure>
830
831 <t>
832 In the VBR case, the (optional) padding length is followed by M-1 frame
833  lengths (indicated by "N1" to "N[M-1]" in the figure below), each encoded in a
834  one- or two-byte sequence as described above.
835 The packet MUST contain enough data for the M-1 lengths after removing the
836  (optional) padding, and the sum of these lengths MUST be no larger than the
837  number of bytes remaining in the packet after decoding them.
838 The compressed data for all M frames follows, each frame consisting of the
839  indicated number of bytes, with the final frame consuming any remaining bytes
840  before the final padding, as illustrated in <xref target="code3cbr_packet"/>.
841 The number of header bytes (TOC byte, frame count byte, padding length bytes,
842  and frame length bytes), plus the length of the first M-1 frames themselves,
843  plus the length of the padding MUST be no larger than N, the total size of the
844  packet.
845 </t>
846
847 <figure anchor="code3vbr_packet" title="A VBR Code 3 Packet" align="center">
848 <artwork align="center"><![CDATA[
849  0                   1                   2                   3
850  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
851 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
852 | config  |s|1|1|1|p|     M     | Padding length (Optional)     :
853 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
854 : N1 (1-2 bytes): N2 (1-2 bytes):     ...       :     N[M-1]    |
855 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
856 |                                                               |
857 :               Compressed frame 1 (N1 bytes)...                :
858 |                                                               |
859 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
860 |                                                               |
861 :               Compressed frame 2 (N2 bytes)...                :
862 |                                                               |
863 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
864 |                                                               |
865 :                              ...                              :
866 |                                                               |
867 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
868 |                                                               |
869 :                     Compressed frame M...                     :
870 |                                                               |
871 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
872 :                  Opus Padding (Optional)...                   |
873 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
874 ]]></artwork>
875 </figure>
876 </section>
877 </section>
878
879 <section anchor="examples" title="Examples">
880 <t>
881 Simplest case, one NB mono 20&nbsp;ms SILK frame:
882 </t>
883
884 <figure>
885 <artwork><![CDATA[
886  0                   1                   2                   3
887  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
888 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
889 |    1    |0|0|0|               compressed data...              :
890 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
891 ]]></artwork>
892 </figure>
893
894 <t>
895 Two FB mono 5&nbsp;ms CELT frames of the same compressed size:
896 </t>
897
898 <figure>
899 <artwork><![CDATA[
900  0                   1                   2                   3
901  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
902 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
903 |   29    |0|0|1|               compressed data...              :
904 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
905 ]]></artwork>
906 </figure>
907
908 <t>
909 Two FB mono 20&nbsp;ms Hybrid frames of different compressed size:
910 </t>
911
912 <figure>
913 <artwork><![CDATA[
914  0                   1                   2                   3
915  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
916 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
917 |   15    |0|1|1|1|0|     2     |      N1       |               |
918 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+               |
919 |                       compressed data...                      :
920 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
921 ]]></artwork>
922 </figure>
923
924 <t>
925 Four FB stereo 20&nbsp;ms CELT frames of the same compressed size:
926 </t>
927
928 <figure>
929 <artwork><![CDATA[
930  0                   1                   2                   3
931  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
932 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
933 |   31    |1|1|1|0|0|     4     |      compressed data...       :
934 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
935 ]]></artwork>
936 </figure>
937 </section>
938
939 <section title="Receiving Malformed Packets">
940 <t>
941 A receiver MUST NOT process packets which violate any of the rules above as
942  normal Opus packets.
943 They are reserved for future applications, such as in-band headers (containing
944  metadata, etc.).
945 Packets which violate these constraints may cause implementations of
946  <spanx style="emph">this</spanx> specification to treat them as malformed, and
947  discard them.
948 </t>
949 <t>
950 These constraints are summarized here for reference:
951 <list style="symbols">
952 <t>Packets are at least one byte.</t>
953 <t>No implicit frame length is larger than 1275 bytes.</t>
954 <t>Code 1 packets have an odd total length, N, so that (N-1)/2 is an
955  integer.</t>
956 <t>Code 2 packets have enough bytes after the TOC for a valid frame length, and
957  that length is no larger than the number of bytes remaining in the packet.</t>
958 <t>Code 3 packets contain at least one frame, but no more than 120&nbsp;ms of
959  audio total.</t>
960 <t>The length of a CBR code 3 packet, N, is at least two bytes, the number of
961  bytes added to indicate the padding size plus the trailing padding bytes
962  themselves, P, is no more than N-2, and the frame count, M, satisfies
963  the constraint that (N-2-P) is a non-negative integer multiple of M.</t>
964 <t>VBR code 3 packets are large enough to contain all the header bytes (TOC
965  byte, frame count byte, any padding length bytes, and any frame length bytes),
966  plus the length of the first M-1 frames, plus any trailing padding bytes.</t>
967 </list>
968 </t>
969 </section>
970
971 </section>
972
973 <section title="Opus Decoder">
974 <t>
975 The Opus decoder consists of two main blocks: the SILK decoder and the CELT
976  decoder.
977 At any given time, one or both of the SILK and CELT decoders may be active.
978 The output of the Opus decode is the sum of the outputs from the SILK and CELT
979  decoders with proper sample rate conversion and delay compensation on the SILK
980  side, and optional decimation (when decoding to sample rates less than
981  48&nbsp;kHz) on the CELT side, as illustrated in the block diagram below.
982 </t>
983 <figure>
984 <artwork>
985 <![CDATA[
986                          +---------+    +------------+
987                          |  SILK   |    |   Sample   |
988                       +->| Decoder |--->|    Rate    |----+
989 Bit-    +---------+   |  |         |    | Conversion |    v
990 stream  |  Range  |---+  +---------+    +------------+  /---\  Audio
991 ------->| Decoder |                                     | + |------>
992         |         |---+  +---------+    +------------+  \---/
993         +---------+   |  |  CELT   |    | Decimation |    ^
994                       +->| Decoder |--->| (Optional) |----+
995                          |         |    |            |
996                          +---------+    +------------+
997 ]]>
998 </artwork>
999 </figure>
1000
1001 <section anchor="range-decoder" title="Range Decoder">
1002 <t>
1003 Opus uses an entropy coder based on <xref target="range-coding"></xref>,
1004 which is itself a rediscovery of the FIFO arithmetic code introduced by <xref target="coding-thesis"></xref>.
1005 It is very similar to arithmetic encoding, except that encoding is done with
1006 digits in any base instead of with bits,
1007 so it is faster when using larger bases (i.e., an octet). All of the
1008 calculations in the range coder must use bit-exact integer arithmetic.
1009 </t>
1010 <t>
1011 Symbols may also be coded as "raw bits" packed directly into the bitstream,
1012  bypassing the range coder.
1013 These are packed backwards starting at the end of the frame, as illustrated in
1014  <xref target="rawbits-example"/>.
1015 This reduces complexity and makes the stream more resilient to bit errors, as
1016  corruption in the raw bits will not desynchronize the decoding process, unlike
1017  corruption in the input to the range decoder.
1018 Raw bits are only used in the CELT layer.
1019 </t>
1020
1021 <figure anchor="rawbits-example" title="Illustrative example of packing range
1022  coder and raw bits data">
1023 <artwork align="center"><![CDATA[
1024  0                   1                   2                   3
1025  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
1026 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
1027 | Range coder data (packed MSB to LSB) ->                       :
1028 +                                                               +
1029 :                                                               :
1030 +     +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
1031 :     | <- Boundary occurs at an arbitrary bit position         :
1032 +-+-+-+                                                         +
1033 :                          <- Raw bits data (packed LSB to MSB) |
1034 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
1035 ]]></artwork>
1036 </figure>
1037
1038 <t>
1039 Each symbol coded by the range coder is drawn from a finite alphabet and coded
1040  in a separate "context", which describes the size of the alphabet and the
1041  relative frequency of each symbol in that alphabet.
1042 </t>
1043 <t>
1044 Suppose there is a context with n symbols, identified with an index that ranges
1045  from 0 to n-1.
1046 The parameters needed to encode or decode symbol k in this context are
1047  represented by a three-tuple (fl[k],&nbsp;fh[k],&nbsp;ft), with
1048  0&nbsp;&lt;=&nbsp;fl[k]&nbsp;&lt;&nbsp;fh[k]&nbsp;&lt;=&nbsp;ft&nbsp;&lt;=&nbsp;65535.
1049 The values of this tuple are derived from the probability model for the
1050  symbol, represented by traditional "frequency counts".
1051 Because Opus uses static contexts these are not updated as symbols are decoded.
1052 Let f[i] be the frequency of symbol i.
1053 Then the three-tuple corresponding to symbol k is given by
1054 </t>
1055 <figure align="center">
1056 <artwork align="center"><![CDATA[
1057         k-1                                   n-1
1058         __                                    __
1059 fl[k] = \  f[i],  fh[k] = fl[k] + f[k],  ft = \  f[i]
1060         /_                                    /_
1061         i=0                                   i=0
1062 ]]></artwork>
1063 </figure>
1064 <t>
1065 The range decoder extracts the symbols and integers encoded using the range
1066  encoder in <xref target="range-encoder"/>.
1067 The range decoder maintains an internal state vector composed of the two-tuple
1068  (val,&nbsp;rng), representing the difference between the high end of the
1069  current range and the actual coded value, minus one, and the size of the
1070  current range, respectively.
1071 Both val and rng are 32-bit unsigned integer values.
1072 The decoder initializes rng to 128 and initializes val to 127 minus the top 7
1073  bits of the first input octet.
1074 It saves the remaining bit for use in the renormalization procedure described
1075  in <xref target="range-decoder-renorm"/>, which the decoder invokes
1076  immediately after initialization to read additional bits and establish the
1077  invariant that rng&nbsp;&gt;&nbsp;2**23.
1078 </t>
1079
1080 <section anchor="decoding-symbols" title="Decoding Symbols">
1081 <t>
1082 Decoding a symbol is a two-step process.
1083 The first step determines a 16-bit unsigned value fs, which lies within the
1084  range of some symbol in the current context.
1085 The second step updates the range decoder state with the three-tuple
1086  (fl[k],&nbsp;fh[k],&nbsp;ft) corresponding to that symbol.
1087 </t>
1088 <t>
1089 The first step is implemented by ec_decode() (entdec.c), which computes
1090 <figure align="center">
1091 <artwork align="center"><![CDATA[
1092                val
1093 fs = ft - min(------ + 1, ft) .
1094               rng/ft
1095 ]]></artwork>
1096 </figure>
1097 The divisions here are exact integer division.
1098 </t>
1099 <t>
1100 The decoder then identifies the symbol in the current context corresponding to
1101  fs; i.e., the value of k whose three-tuple (fl[k],&nbsp;fh[k],&nbsp;ft)
1102  satisfies fl[k]&nbsp;&lt;=&nbsp;fs&nbsp;&lt;&nbsp;fh[k].
1103 It uses this tuple to update val according to
1104 <figure align="center">
1105 <artwork align="center"><![CDATA[
1106             rng
1107 val = val - --- * (ft - fh[k]) .
1108             ft
1109 ]]></artwork>
1110 </figure>
1111 If fl[k] is greater than zero, then the decoder updates rng using
1112 <figure align="center">
1113 <artwork align="center"><![CDATA[
1114       rng
1115 rng = --- * (fh[k] - fl[k]) .
1116       ft
1117 ]]></artwork>
1118 </figure>
1119 Otherwise, it updates rng using
1120 <figure align="center">
1121 <artwork align="center"><![CDATA[
1122             rng
1123 rng = rng - --- * (ft - fh[k]) .
1124             ft
1125 ]]></artwork>
1126 </figure>
1127 </t>
1128 <t>
1129 Using a special case for the first symbol (rather than the last symbol, as is
1130  commonly done in other arithmetic coders) ensures that all the truncation
1131  error from the finite precision arithmetic accumulates in symbol 0.
1132 This makes the cost of coding a 0 slightly smaller, on average, than its
1133  estimated probability indicates and makes the cost of coding any other symbol
1134  slightly larger.
1135 When contexts are designed so that 0 is the most probable symbol, which is
1136  often the case, this strategy minimizes the inefficiency introduced by the
1137  finite precision.
1138 It also makes some of the special-case decoding routines in
1139  <xref target="decoding-alternate"/> particularly simple.
1140 </t>
1141 <t>
1142 After the updates, implemented by ec_dec_update() (entdec.c), the decoder
1143  normalizes the range using the procedure in the next section, and returns the
1144  index k.
1145 </t>
1146
1147 <section anchor="range-decoder-renorm" title="Renormalization">
1148 <t>
1149 To normalize the range, the decoder repeats the following process, implemented
1150  by ec_dec_normalize() (entdec.c), until rng&nbsp;&gt;&nbsp;2**23.
1151 If rng is already greater than 2**23, the entire process is skipped.
1152 First, it sets rng to (rng&lt;&lt;8).
1153 Then it reads the next octet of the payload and combines it with the left-over
1154  bit buffered from the previous octet to form the 8-bit value sym.
1155 It takes the left-over bit as the high bit (bit 7) of sym, and the top 7 bits
1156  of the octet it just read as the other 7 bits of sym.
1157 The remaining bit in the octet just read is buffered for use in the next
1158  iteration.
1159 If no more input octets remain, it uses zero bits instead.
1160 Then, it sets
1161 <figure align="center">
1162 <artwork align="center"><![CDATA[
1163 val = ((val<<8) + (255-sym)) & 0x7FFFFFFF .
1164 ]]></artwork>
1165 </figure>
1166 </t>
1167 <t>
1168 It is normal and expected that the range decoder will read several bytes
1169  into the raw bits data (if any) at the end of the packet by the time the frame
1170  is completely decoded, as illustrated in <xref target="finalize-example"/>.
1171 This same data MUST also be returned as raw bits when requested.
1172 The encoder is expected to terminate the stream in such a way that the decoder
1173  will decode the intended values regardless of the data contained in the raw
1174  bits.
1175 <xref target="encoder-finalizing"/> describes a procedure for doing this.
1176 If the range decoder consumes all of the bytes belonging to the current frame,
1177  it MUST continue to use zero when any further input bytes are required, even
1178  if there is additional data in the current packet from padding or other
1179  frames.
1180 </t>
1181
1182 <figure anchor="finalize-example" title="Illustrative example of raw bits
1183  overlapping range coder data">
1184 <artwork align="center"><![CDATA[
1185  n              n+1             n+2             n+3
1186  0 1 2 3 4 5 6 7 0 1 2 3 4 5 6 7 0 1 2 3 4 5 6 7 0 1 2 3 4 5 6 7
1187 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
1188 :     | <----------- Overlap region ------------> |             :
1189 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
1190       ^                                           ^
1191       |   End of data buffered by the range coder |
1192 ...-----------------------------------------------+
1193       |
1194       | End of data consumed by raw bits
1195       +-------------------------------------------------------...
1196 ]]></artwork>
1197 </figure>
1198 </section>
1199 </section>
1200
1201 <section anchor="decoding-alternate" title="Alternate Decoding Methods">
1202 <t>
1203 The reference implementation uses three additional decoding methods that are
1204  exactly equivalent to the above, but make assumptions and simplifications that
1205  allow for a more efficient implementation.
1206 </t>
1207 <section anchor="ec_decode_bin" title="ec_decode_bin()">
1208 <t>
1209 The first is ec_decode_bin() (entdec.c), defined using the parameter ftb
1210  instead of ft.
1211 It is mathematically equivalent to calling ec_decode() with
1212  ft&nbsp;=&nbsp;(1&lt;&lt;ftb), but avoids one of the divisions.
1213 </t>
1214 </section>
1215 <section anchor="ec_dec_bit_logp" title="ec_dec_bit_logp()">
1216 <t>
1217 The next is ec_dec_bit_logp() (entdec.c), which decodes a single binary symbol,
1218  replacing both the ec_decode() and ec_dec_update() steps.
1219 The context is described by a single parameter, logp, which is the absolute
1220  value of the base-2 logarithm of the probability of a "1".
1221 It is mathematically equivalent to calling ec_decode() with
1222  ft&nbsp;=&nbsp;(1&lt;&lt;logp), followed by ec_dec_update() with
1223  the 3-tuple (fl[k]&nbsp;=&nbsp;0,
1224  fh[k]&nbsp;=&nbsp;(1&lt;&lt;logp)&nbsp;-&nbsp;1,
1225  ft&nbsp;=&nbsp;(1&lt;&lt;logp)) if the returned value
1226  of fs is less than (1&lt;&lt;logp)&nbsp;-&nbsp;1 (a "0" was decoded), and with
1227  (fl[k]&nbsp;=&nbsp;(1&lt;&lt;logp)&nbsp;-&nbsp;1,
1228  fh[k]&nbsp;=&nbsp;ft&nbsp;=&nbsp;(1&lt;&lt;logp)) otherwise (a "1" was
1229  decoded).
1230 The implementation requires no multiplications or divisions.
1231 </t>
1232 </section>
1233 <section anchor="ec_dec_icdf" title="ec_dec_icdf()">
1234 <t>
1235 The last is ec_dec_icdf() (entdec.c), which decodes a single symbol with a
1236  table-based context of up to 8 bits, also replacing both the ec_decode() and
1237  ec_dec_update() steps, as well as the search for the decoded symbol in between.
1238 The context is described by two parameters, an icdf
1239  ("inverse" cumulative distribution function) table and ftb.
1240 As with ec_decode_bin(), (1&lt;&lt;ftb) is equivalent to ft.
1241 idcf[k], on the other hand, stores (1&lt;&lt;ftb)-fh[k], which is equal to
1242  (1&lt;&lt;ftb)&nbsp;-&nbsp;fl[k+1].
1243 fl[0] is assumed to be 0, and the table is terminated by a value of 0 (where
1244  fh[k]&nbsp;==&nbsp;ft).
1245 </t>
1246 <t>
1247 The function is mathematically equivalent to calling ec_decode() with
1248  ft&nbsp;=&nbsp;(1&lt;&lt;ftb), using the returned value fs to search the table
1249  for the first entry where fs&nbsp;&lt;&nbsp;(1&lt;&lt;ftb)-icdf[k], and
1250  calling ec_dec_update() with
1251  fl[k]&nbsp;=&nbsp;(1&lt;&lt;ftb)&nbsp;-&nbsp;icdf[k-1] (or 0
1252  if k&nbsp;==&nbsp;0), fh[k]&nbsp;=&nbsp;(1&lt;&lt;ftb)&nbsp;-&nbsp;idcf[k],
1253  and ft&nbsp;=&nbsp;(1&lt;&lt;ftb).
1254 Combining the search with the update allows the division to be replaced by a
1255  series of multiplications (which are usually much cheaper), and using an
1256  inverse CDF allows the use of an ftb as large as 8 in an 8-bit table without
1257  any special cases.
1258 This is the primary interface with the range decoder in the SILK layer, though
1259  it is used in a few places in the CELT layer as well.
1260 </t>
1261 <t>
1262 Although icdf[k] is more convenient for the code, the frequency counts, f[k],
1263  are a more natural representation of the probability distribution function
1264  (PDF) for a given symbol.
1265 Therefore this draft lists the latter, not the former, when describing the
1266  context in which a symbol is coded as a list, e.g., {4, 4, 4, 4}/16 for a
1267  uniform context with four possible values and ft&nbsp;=&nbsp;16.
1268 The value of ft after the slash is always the sum of the entries in the PDF,
1269  but is included for convenience.
1270 Contexts with identical probabilities, f[k]/ft, but different values of ft
1271  (or equivalently, ftb) are not the same, and cannot, in general, be used in
1272  place of one another.
1273 An icdf table is also not capable of representing a PDF where the first symbol
1274  has 0 probability.
1275 In such contexts, ec_dec_icdf() can decode the symbol by using a table that
1276  drops the entries for any initial zero-probability values and adding the
1277  constant offset of the first value with a non-zero probability to its return
1278  value.
1279 </t>
1280 </section>
1281 </section>
1282
1283 <section anchor="decoding-bits" title="Decoding Raw Bits">
1284 <t>
1285 The raw bits used by the CELT layer are packed at the end of the packet, with
1286  the least significant bit of the first value packed in the least significant
1287  bit of the last byte, filling up to the most significant bit in the last byte,
1288  continuing on to the least significant bit of the penultimate byte, and so on.
1289 The reference implementation reads them using ec_dec_bits() (entdec.c).
1290 Because the range decoder must read several bytes ahead in the stream, as
1291  described in <xref target="range-decoder-renorm"/>, the input consumed by the
1292  raw bits may overlap with the input consumed by the range coder, and a decoder
1293  MUST allow this.
1294 The format should render it impossible to attempt to read more raw bits than
1295  there are actual bits in the frame, though a decoder may wish to check for
1296  this and report an error.
1297 </t>
1298 </section>
1299
1300 <section anchor="ec_dec_uint" title="Decoding Uniformly Distributed Integers">
1301 <t>
1302 The function ec_dec_uint() (entdec.c) decodes one of ft equiprobable values in
1303  the range 0 to (ft&nbsp;-&nbsp;1), inclusive, each with a frequency of 1,
1304  where ft may be as large as (2**32&nbsp;-&nbsp;1).
1305 Because ec_decode() is limited to a total frequency of (2**16&nbsp;-&nbsp;1),
1306  it splits up the value into a range coded symbol representing up to 8 of the
1307  high bits, and, if necessary, raw bits representing the remainder of the
1308  value.
1309 The limit of 8 bits in the range coded symbol is a trade-off between
1310  implementation complexity, modeling error (since the symbols no longer truly
1311  have equal coding cost), and rounding error introduced by the range coder
1312  itself (which gets larger as more bits are included).
1313 Using raw bits reduces the maximum number of divisions required in the worst
1314  case, but means that it may be possible to decode a value outside the range
1315  0 to (ft&nbsp;-&nbsp;1), inclusive.
1316 </t>
1317
1318 <t>
1319 ec_dec_uint() takes a single, positive parameter, ft, which is not necessarily
1320  a power of two, and returns an integer, t, whose value lies between 0 and
1321  (ft&nbsp;-&nbsp;1), inclusive.
1322 Let ftb&nbsp;=&nbsp;ilog(ft&nbsp;-&nbsp;1), i.e., the number of bits required
1323  to store (ft&nbsp;-&nbsp;1) in two's complement notation.
1324 If ftb is 8 or less, then t is decoded with t&nbsp;=&nbsp;ec_decode(ft), and
1325  the range coder state is updated using the three-tuple (t, t&nbsp;+&nbsp;1,
1326  ft).
1327 </t>
1328 <t>
1329 If ftb is greater than 8, then the top 8 bits of t are decoded using
1330 <figure align="center">
1331 <artwork align="center"><![CDATA[
1332 t = ec_decode(((ft - 1) >> (ftb - 8)) + 1) ,
1333 ]]></artwork>
1334 </figure>
1335  the decoder state is updated using the three-tuple
1336  (t, t&nbsp;+&nbsp;1,
1337  ((ft&nbsp;-&nbsp;1)&nbsp;&gt;&gt;&nbsp;(ftb&nbsp;-&nbsp;8))&nbsp;+&nbsp;1),
1338  and the remaining bits are decoded as raw bits, setting
1339 <figure align="center">
1340 <artwork align="center"><![CDATA[
1341 t = (t << (ftb - 8)) | ec_dec_bits(ftb - 8) .
1342 ]]></artwork>
1343 </figure>
1344 If, at this point, t >= ft, then the current frame is corrupt.
1345 In that case, the decoder should assume there has been an error in the coding,
1346  decoding, or transmission and SHOULD take measures to conceal the
1347  error and/or report to the application that the error has occurred.
1348 </t>
1349
1350 </section>
1351
1352 <section anchor="decoder-tell" title="Current Bit Usage">
1353 <t>
1354 The bit allocation routines in the CELT decoder need a conservative upper bound
1355  on the number of bits that have been used from the current frame thus far,
1356  including both range coder bits and raw bits.
1357 This drives allocation decisions that must match those made in the encoder.
1358 The upper bound is computed in the reference implementation to whole-bit
1359  precision by the function ec_tell() (entcode.h) and to fractional 1/8th bit
1360  precision by the function ec_tell_frac() (entcode.c).
1361 Like all operations in the range coder, it must be implemented in a bit-exact
1362  manner, and must produce exactly the same value returned by the same functions
1363  in the encoder after encoding the same symbols.
1364 </t>
1365 <t>
1366 ec_tell() is guaranteed to return ceil(ec_tell_frac()/8.0).
1367 In various places the codec will check to ensure there is enough room to
1368  contain a symbol before attempting to decode it.
1369 In practice, although the number of bits used so far is an upper bound,
1370  decoding a symbol whose probability model suggests it has a worst-case cost of
1371  p 1/8th bits may actually advance the return value of ec_tell_frac() by
1372  p-1, p, or p+1 1/8th bits, due to approximation error in that upper bound,
1373  truncation error in the range coder, and for large values of ft, modeling
1374  error in ec_dec_uint().
1375 </t>
1376 <t>
1377 However, this error is bounded, and periodic calls to ec_tell() or
1378  ec_tell_frac() at precisely defined points in the decoding process prevent it
1379  from accumulating.
1380 For a range coder symbol that requires a whole number of bits (i.e.,
1381  for which ft/(fh[k]&nbsp;-&nbsp;fl[k]) is a power of two), where there are at
1382  least p 1/8th bits available, decoding the symbol will never cause ec_tell() or
1383  ec_tell_frac() to exceed the size of the frame ("bust the budget").
1384 In this case the return value of ec_tell_frac() will only advance by more than
1385  p 1/8th bits if there was an additional, fractional number of bits remaining,
1386  and it will never advance beyond the next whole-bit boundary, which is safe,
1387  since frames always contain a whole number of bits.
1388 However, when p is not a whole number of bits, an extra 1/8th bit is required
1389  to ensure that decoding the symbol will not bust the budget.
1390 </t>
1391 <t>
1392 The reference implementation keeps track of the total number of whole bits that
1393  have been processed by the decoder so far in the variable nbits_total,
1394  including the (possibly fractional) number of bits that are currently
1395  buffered, but not consumed, inside the range coder.
1396 nbits_total is initialized to 9 just before the initial range renormalization
1397  process completes (or equivalently, it can be initialized to 33 after the
1398  first renormalization).
1399 The extra two bits over the actual amount buffered by the range coder
1400  guarantees that it is an upper bound and that there is enough room for the
1401  encoder to terminate the stream.
1402 Each iteration through the range coder's renormalization loop increases
1403  nbits_total by 8.
1404 Reading raw bits increases nbits_total by the number of raw bits read.
1405 </t>
1406
1407 <section anchor="ec_tell" title="ec_tell()">
1408 <t>
1409 The whole number of bits buffered in rng may be estimated via lg = ilog(rng).
1410 ec_tell() then becomes a simple matter of removing these bits from the total.
1411 It returns (nbits_total - lg).
1412 </t>
1413 <t>
1414 In a newly initialized decoder, before any symbols have been read, this reports
1415  that 1 bit has been used.
1416 This is the bit reserved for termination of the encoder.
1417 </t>
1418 </section>
1419
1420 <section anchor="ec_tell_frac" title="ec_tell_frac()">
1421 <t>
1422 ec_tell_frac() estimates the number of bits buffered in rng to fractional
1423  precision.
1424 Since rng must be greater than 2**23 after renormalization, lg must be at least
1425  24.
1426 Let
1427 <figure align="center">
1428 <artwork align="center">
1429 <![CDATA[
1430 r_Q15 = rng >> (l-16) ,
1431 ]]></artwork>
1432 </figure>
1433  so that 32768 &lt;= r_Q15 &lt; 65536, an unsigned Q15 value representing the
1434  fractional part of rng.
1435 Then the following procedure can be used to add one bit of precision to lg.
1436 First, update
1437 <figure align="center">
1438 <artwork align="center">
1439 <![CDATA[
1440 r_Q15 = (r_Q15*r_Q15) >> 15 .
1441 ]]></artwork>
1442 </figure>
1443 Then add the 16th bit of r_Q15 to lg via
1444 <figure align="center">
1445 <artwork align="center">
1446 <![CDATA[
1447 lg = 2*lg + (r_Q15 >> 16) .
1448 ]]></artwork>
1449 </figure>
1450 Finally, if this bit was a 1, reduce r_Q15 by a factor of two via
1451 <figure align="center">
1452 <artwork align="center">
1453 <![CDATA[
1454 r_Q15 = r_Q15 >> 1 ,
1455 ]]></artwork>
1456 </figure>
1457  so that it once again lies in the range 32768 &lt;= r_Q15 &lt; 65536.
1458 </t>
1459 <t>
1460 This procedure is repeated three times to extend lg to 1/8th bit precision.
1461 ec_tell_frac() then returns (nbits_total*8 - lg).
1462 </t>
1463 </section>
1464
1465 </section>
1466
1467 </section>
1468
1469 <section anchor="silk_decoder_outline" title="SILK Decoder">
1470 <t>
1471 The decoder's LP layer uses a modified version of the SILK codec (herein simply
1472  called "SILK"), which runs a decoded excitation signal through adaptive
1473  long-term and short-term prediction synthesis filters.
1474 It runs at NB, MB, and WB sample rates internally.
1475 When used in a SWB or FB Hybrid frame, the LP layer itself still only runs in
1476  WB.
1477 </t>
1478
1479 <section title="SILK Decoder Modules">
1480 <t>
1481 An overview of the decoder is given in <xref target="silk_decoder_figure"/>.
1482 </t>
1483 <figure align="center" anchor="silk_decoder_figure" title="SILK Decoder">
1484 <artwork align="center">
1485 <![CDATA[
1486    +---------+    +------------+
1487 -->| Range   |--->| Decode     |---------------------------+
1488  1 | Decoder | 2  | Parameters |----------+       5        |
1489    +---------+    +------------+     4    |                |
1490                        3 |                |                |
1491                         \/               \/               \/
1492                   +------------+   +------------+   +------------+
1493                   | Generate   |-->| LTP        |-->| LPC        |
1494                   | Excitation |   | Synthesis  |   | Synthesis  |
1495                   +------------+   +------------+   +------------+
1496                                           ^                |
1497                                           |                |
1498                       +-------------------+----------------+
1499                       |                                      6
1500                       |   +------------+   +-------------+
1501                       +-->| Stereo     |-->| Sample Rate |-->
1502                           | Unmixing   | 7 | Conversion  | 8
1503                           +------------+   +-------------+
1504
1505 1: Range encoded bitstream
1506 2: Coded parameters
1507 3: Pulses, LSBs, and signs
1508 4: Pitch lags, LTP coefficients
1509 5: LPC coefficients and gains
1510 6: Decoded signal (mono or mid-side stereo)
1511 7: Unmixed signal (mono or left-right stereo)
1512 8: Resampled signal
1513 ]]>
1514 </artwork>
1515 </figure>
1516
1517 <t>
1518 The decoder feeds the bitstream (1) to the range decoder from
1519  <xref target="range-decoder"/>, and then decodes the parameters in it (2)
1520  using the procedures detailed in
1521  Sections&nbsp;<xref format="counter" target="silk_header_bits"/>
1522  through&nbsp;<xref format="counter" target="silk_signs"/>.
1523 These parameters (3, 4, 5) are used to generate an excitation signal (see
1524  <xref target="silk_excitation_reconstruction"/>), which is fed to an optional
1525  long-term prediction (LTP) filter (voiced frames only, see
1526  <xref target="silk_ltp_synthesis"/>) and then a short-term prediction filter
1527  (see <xref target="silk_lpc_synthesis"/>), producing the decoded signal (6).
1528 For stereo streams, the mid-side representation is converted to separate left
1529  and right channels (7).
1530 The result is finally resampled to the desired output sample rate (e.g.,
1531  48&nbsp;kHz) so that the resampled signal (8) can be mixed with the CELT
1532  layer.
1533 </t>
1534
1535 </section>
1536
1537 <section anchor="silk_layer_organization" title="LP Layer Organization">
1538
1539 <t>
1540 Internally, the LP layer of a single Opus frame is composed of either a single
1541  10&nbsp;ms regular SILK frame or between one and three 20&nbsp;ms regular SILK
1542  frames.
1543 A stereo Opus frame may double the number of regular SILK frames (up to a total
1544  of six), since it includes separate frames for a mid channel and, optionally,
1545  a side channel.
1546 Optional Low Bit-Rate Redundancy (LBRR) frames, which are reduced-bitrate
1547  encodings of previous SILK frames, may be included to aid in recovery from
1548  packet loss.
1549 If present, these appear before the regular SILK frames.
1550 They are in most respects identical to regular, active SILK frames, except that
1551  they are usually encoded with a lower bitrate.
1552 This draft uses "SILK frame" to refer to either one and "regular SILK frame" if
1553  it needs to draw a distinction between the two.
1554 </t>
1555 <t>
1556 Logically, each SILK frame is in turn composed of either two or four 5&nbsp;ms
1557  subframes.
1558 Various parameters, such as the quantization gain of the excitation and the
1559  pitch lag and filter coefficients can vary on a subframe-by-subframe basis.
1560 Physically, the parameters for each subframe are interleaved in the bitstream,
1561  as described in the relevant sections for each parameter.
1562 </t>
1563 <t>
1564 All of these frames and subframes are decoded from the same range coder, with
1565  no padding between them.
1566 Thus packing multiple SILK frames in a single Opus frame saves, on average,
1567  half a byte per SILK frame.
1568 It also allows some parameters to be predicted from prior SILK frames in the
1569  same Opus frame, since this does not degrade packet loss robustness (beyond
1570  any penalty for merely using fewer, larger packets to store multiple frames).
1571 </t>
1572
1573 <t>
1574 Stereo support in SILK uses a variant of mid-side coding, allowing a mono
1575  decoder to simply decode the mid channel.
1576 However, the data for the two channels is interleaved, so a mono decoder must
1577  still unpack the data for the side channel.
1578 It would be required to do so anyway for Hybrid Opus frames, or to support
1579  decoding individual 20&nbsp;ms frames.
1580 </t>
1581
1582 <t>
1583 <xref target="silk_symbols"/> summarizes the overall grouping of the contents of
1584  the LP layer.
1585 Figures&nbsp;<xref format="counter" target="silk_mono_60ms_frame"/>
1586  and&nbsp;<xref format="counter" target="silk_stereo_60ms_frame"/> illustrate
1587  the ordering of the various SILK frames for a 60&nbsp;ms Opus frame, for both
1588  mono and stereo, respectively.
1589 </t>
1590
1591 <texttable anchor="silk_symbols"
1592  title="Organization of the SILK layer of an Opus frame">
1593 <ttcol align="center">Symbol(s)</ttcol>
1594 <ttcol align="center">PDF(s)</ttcol>
1595 <ttcol align="center">Condition</ttcol>
1596
1597 <c>VAD flags</c>
1598 <c>{1, 1}/2</c>
1599 <c/>
1600
1601 <c>LBRR flag</c>
1602 <c>{1, 1}/2</c>
1603 <c/>
1604
1605 <c>Per-frame LBRR flags</c>
1606 <c><xref target="silk_lbrr_flag_pdfs"/></c>
1607 <c><xref target="silk_lbrr_flags"/></c>
1608
1609 <c>LBRR Frame(s)</c>
1610 <c><xref target="silk_frame"/></c>
1611 <c><xref target="silk_lbrr_flags"/></c>
1612
1613 <c>Regular SILK Frame(s)</c>
1614 <c><xref target="silk_frame"/></c>
1615 <c/>
1616
1617 </texttable>
1618
1619 <figure align="center" anchor="silk_mono_60ms_frame"
1620  title="A 60&nbsp;ms Mono Frame">
1621 <artwork align="center"><![CDATA[
1622 +---------------------------------+
1623 |            VAD Flags            |
1624 +---------------------------------+
1625 |            LBRR Flag            |
1626 +---------------------------------+
1627 | Per-Frame LBRR Flags (Optional) |
1628 +---------------------------------+
1629 |     LBRR Frame 1 (Optional)     |
1630 +---------------------------------+
1631 |     LBRR Frame 2 (Optional)     |
1632 +---------------------------------+
1633 |     LBRR Frame 3 (Optional)     |
1634 +---------------------------------+
1635 |      Regular SILK Frame 1       |
1636 +---------------------------------+
1637 |      Regular SILK Frame 2       |
1638 +---------------------------------+
1639 |      Regular SILK Frame 3       |
1640 +---------------------------------+
1641 ]]></artwork>
1642 </figure>
1643
1644 <figure align="center" anchor="silk_stereo_60ms_frame"
1645  title="A 60&nbsp;ms Stereo Frame">
1646 <artwork align="center"><![CDATA[
1647 +---------------------------------------+
1648 |             Mid VAD Flags             |
1649 +---------------------------------------+
1650 |             Mid LBRR Flag             |
1651 +---------------------------------------+
1652 |             Side VAD Flags            |
1653 +---------------------------------------+
1654 |             Side LBRR Flag            |
1655 +---------------------------------------+
1656 |  Mid Per-Frame LBRR Flags (Optional)  |
1657 +---------------------------------------+
1658 | Side Per-Frame LBRR Flags (Optional)  |
1659 +---------------------------------------+
1660 |     Mid LBRR Frame 1 (Optional)       |
1661 +---------------------------------------+
1662 |     Side LBRR Frame 1 (Optional)      |
1663 +---------------------------------------+
1664 |     Mid LBRR Frame 2 (Optional)       |
1665 +---------------------------------------+
1666 |     Side LBRR Frame 2 (Optional)      |
1667 +---------------------------------------+
1668 |     Mid LBRR Frame 3 (Optional)       |
1669 +---------------------------------------+
1670 |     Side LBRR Frame 3 (Optional)      |
1671 +---------------------------------------+
1672 |      Mid Regular SILK Frame 1         |
1673 +---------------------------------------+
1674 | Side Regular SILK Frame 1 (Optional)  |
1675 +---------------------------------------+
1676 |      Mid Regular SILK Frame 2         |
1677 +---------------------------------------+
1678 | Side Regular SILK Frame 2 (Optional)  |
1679 +---------------------------------------+
1680 |      Mid Regular SILK Frame 3         |
1681 +---------------------------------------+
1682 | Side Regular SILK Frame 3 (Optional)  |
1683 +---------------------------------------+
1684 ]]></artwork>
1685 </figure>
1686
1687 </section>
1688
1689 <section anchor="silk_header_bits" title="Header Bits">
1690 <t>
1691 The LP layer begins with two to eight header bits, decoded in silk_Decode()
1692  (dec_API.c).
1693 These consist of one Voice Activity Detection (VAD) bit per frame (up to 3),
1694  followed by a single flag indicating the presence of LBRR frames.
1695 For a stereo packet, these first flags correspond to the mid channel, and a
1696  second set of flags is included for the side channel.
1697 </t>
1698 <t>
1699 Because these are the first symbols decoded by the range coder and because they
1700  are coded as binary values with uniform probability, they can be extracted
1701  directly from the most significant bits of the first byte of compressed data.
1702 Thus, a receiver can determine if an Opus frame contains any active SILK frames
1703  without the overhead of using the range decoder.
1704 </t>
1705 </section>
1706
1707 <section anchor="silk_lbrr_flags" title="Per-Frame LBRR Flags">
1708 <t>
1709 For Opus frames longer than 20&nbsp;ms, a set of LBRR flags is
1710  decoded for each channel that has its LBRR flag set.
1711 Each set contains one flag per 20&nbsp;ms SILK frame.
1712 40&nbsp;ms Opus frames use the 2-frame LBRR flag PDF from
1713  <xref target="silk_lbrr_flag_pdfs"/>, and 60&nbsp;ms Opus frames use the
1714  3-frame LBRR flag PDF.
1715 For each channel, the resulting 2- or 3-bit integer contains the corresponding
1716  LBRR flag for each frame, packed in order from the LSB to the MSB.
1717 </t>
1718
1719 <texttable anchor="silk_lbrr_flag_pdfs" title="LBRR Flag PDFs">
1720 <ttcol>Frame Size</ttcol>
1721 <ttcol>PDF</ttcol>
1722 <c>40&nbsp;ms</c> <c>{0, 53, 53, 150}/256</c>
1723 <c>60&nbsp;ms</c> <c>{0, 41, 20, 29, 41, 15, 28, 82}/256</c>
1724 </texttable>
1725
1726 <t>
1727 A 10&nbsp;or 20&nbsp;ms Opus frame does not contain any per-frame LBRR flags,
1728  as there may be at most one LBRR frame per channel.
1729 The global LBRR flag in the header bits (see <xref target="silk_header_bits"/>)
1730  is already sufficient to indicate the presence of that single LBRR frame.
1731 </t>
1732
1733 </section>
1734
1735 <section anchor="silk_lbrr_frames" title="LBRR Frames">
1736 <t>
1737 The LBRR frames, if present, contain an encoded representation of the signal
1738  immediately prior to the current Opus frame as if it were encoded with the
1739  current mode, frame size, audio bandwidth, and channel count, even if those
1740  differ from the prior Opus frame.
1741 When one of these parameters changes from one Opus frame to the next, this
1742  implies that the LBRR frames of the current Opus frame may not be simple
1743  drop-in replacements for the contents of the previous Opus frame.
1744 </t>
1745
1746 <t>
1747 For example, when switching from 20&nbsp;ms to 60&nbsp;ms, the 60&nbsp;ms Opus
1748  frame may contain LBRR frames covering up to three prior 20&nbsp;ms Opus
1749  frames, even if those frames already contained LBRR frames covering some of
1750  the same time periods.
1751 When switching from 20&nbsp;ms to 10&nbsp;ms, the 10&nbsp;ms Opus frame can
1752  contain an LBRR frame covering at most half the prior 20&nbsp;ms Opus frame,
1753  potentially leaving a hole that needs to be concealed from even a single
1754  packet loss.
1755 When switching from mono to stereo, the LBRR frames in the first stereo Opus
1756  frame MAY contain a non-trivial side channel.
1757 </t>
1758
1759 <t>
1760 In order to properly produce LBRR frames under all conditions, an encoder might
1761  need to buffer up to 60&nbsp;ms of audio and re-encode it during these
1762  transitions.
1763 However, the reference implementation opts to disable LBRR frames at the
1764  transition point for simplicity.
1765 </t>
1766
1767 <t>
1768 The LBRR frames immediately follow the LBRR flags, prior to any regular SILK
1769  frames.
1770 <xref target="silk_frame"/> describes their exact contents.
1771 LBRR frames do not include their own separate VAD flags.
1772 LBRR frames are only meant to be transmitted for active speech, thus all LBRR
1773  frames are treated as active.
1774 </t>
1775
1776 <t>
1777 In a stereo Opus frame longer than 20&nbsp;ms, although the per-frame LBRR
1778  flags for the mid channel are coded as a unit before the per-frame LBRR flags
1779  for the side channel, the LBRR frames themselves are interleaved.
1780 The decoder parses an LBRR frame for the mid channel of a given 20&nbsp;ms
1781  interval (if present) and then immediately parses the corresponding LBRR
1782  frame for the side channel (if present), before proceeding to the next
1783  20&nbsp;ms interval.
1784 </t>
1785 </section>
1786
1787 <section anchor="silk_regular_frames" title="Regular SILK Frames">
1788 <t>
1789 The regular SILK frame(s) follow the LBRR frames (if any).
1790 <xref target="silk_frame"/> describes their contents, as well.
1791 Unlike the LBRR frames, a regular SILK frame is coded for each time interval in
1792  an Opus frame, even if the corresponding VAD flags are unset.
1793 For stereo Opus frames longer than 20&nbsp;ms, the regular mid and side SILK
1794  frames for each 20&nbsp;ms interval are interleaved, just as with the LBRR
1795  frames.
1796 The side frame may be skipped by coding an appropriate flag, as detailed in
1797  <xref target="silk_mid_only_flag"/>.
1798 </t>
1799 </section>
1800
1801 <section anchor="silk_frame" title="SILK Frame Contents">
1802 <t>
1803 Each SILK frame includes a set of side information that encodes
1804 <list style="symbols">
1805 <t>The frame type and quantization type (<xref target="silk_frame_type"/>),</t>
1806 <t>Quantization gains (<xref target="silk_gains"/>),</t>
1807 <t>Short-term prediction filter coefficients (<xref target="silk_nlsfs"/>),</t>
1808 <t>An LSF interpolation weight (<xref target="silk_nlsf_interpolation"/>),</t>
1809 <t>
1810 Long-term prediction filter lags and gains (<xref target="silk_ltp_params"/>),
1811  and
1812 </t>
1813 <t>A linear congruential generator (LCG) seed (<xref target="silk_seed"/>).</t>
1814 </list>
1815 The quantized excitation signal (see <xref target="silk_excitation"/>) follows
1816  these at the end of the frame.
1817 <xref target="silk_frame_symbols"/> details the overall organization of a
1818  SILK frame.
1819 </t>
1820
1821 <texttable anchor="silk_frame_symbols"
1822  title="Order of the symbols in an individual SILK frame">
1823 <ttcol align="center">Symbol(s)</ttcol>
1824 <ttcol align="center">PDF(s)</ttcol>
1825 <ttcol align="center">Condition</ttcol>
1826
1827 <c>Stereo Prediction Weights</c>
1828 <c><xref target="silk_stereo_pred_pdfs"/></c>
1829 <c><xref target="silk_stereo_pred"/></c>
1830
1831 <c>Mid-only Flag</c>
1832 <c><xref target="silk_mid_only_pdf"/></c>
1833 <c><xref target="silk_mid_only_flag"/></c>
1834
1835 <c>Frame Type</c>
1836 <c><xref target="silk_frame_type"/></c>
1837 <c/>
1838
1839 <c>Subframe Gains</c>
1840 <c><xref target="silk_gains"/></c>
1841 <c/>
1842
1843 <c>Normalized LSF Stage 1 Index</c>
1844 <c><xref target="silk_nlsf_stage1_pdfs"/></c>
1845 <c/>
1846
1847 <c>Normalized LSF Stage 2 Residual</c>
1848 <c><xref target="silk_nlsf_stage2"/></c>
1849 <c/>
1850
1851 <c>Normalized LSF Interpolation Weight</c>
1852 <c><xref target="silk_nlsf_interp_pdf"/></c>
1853 <c>20&nbsp;ms frame</c>
1854
1855 <c>Primary Pitch Lag</c>
1856 <c><xref target="silk_ltp_lags"/></c>
1857 <c>Voiced frame</c>
1858
1859 <c>Subframe Pitch Contour</c>
1860 <c><xref target="silk_pitch_contour_pdfs"/></c>
1861 <c>Voiced frame</c>
1862
1863 <c>Periodicity Index</c>
1864 <c><xref target="silk_perindex_pdf"/></c>
1865 <c>Voiced frame</c>
1866
1867 <c>LTP Filter</c>
1868 <c><xref target="silk_ltp_filter_pdfs"/></c>
1869 <c>Voiced frame</c>
1870
1871 <c>LTP Scaling</c>
1872 <c><xref target="silk_ltp_scaling_pdf"/></c>
1873 <c><xref target="silk_ltp_scaling"/></c>
1874
1875 <c>LCG Seed</c>
1876 <c><xref target="silk_seed_pdf"/></c>
1877 <c/>
1878
1879 <c>Excitation Rate Level</c>
1880 <c><xref target="silk_rate_level_pdfs"/></c>
1881 <c/>
1882
1883 <c>Excitation Pulse Counts</c>
1884 <c><xref target="silk_pulse_count_pdfs"/></c>
1885 <c/>
1886
1887 <c>Excitation Pulse Locations</c>
1888 <c><xref target="silk_pulse_locations"/></c>
1889 <c>Non-zero pulse count</c>
1890
1891 <c>Excitation LSBs</c>
1892 <c><xref target="silk_shell_lsb_pdf"/></c>
1893 <c><xref target="silk_pulse_counts"/></c>
1894
1895 <c>Excitation Signs</c>
1896 <c><xref target="silk_sign_pdfs"/></c>
1897 <c/>
1898
1899 </texttable>
1900
1901 <section anchor="silk_stereo_pred" toc="include"
1902  title="Stereo Prediction Weights">
1903 <t>
1904 A SILK frame corresponding to the mid channel of a stereo Opus frame begins
1905  with a pair of side channel prediction weights, designed such that zeros
1906  indicate normal mid-side coupling.
1907 Since these weights can change on every frame, the first portion of each frame
1908  linearly interpolates between the previous weights and the current ones, using
1909  zeros for the previous weights if none are available.
1910 These prediction weights are never included in a mono Opus frame, and the
1911  previous weights are reset to zeros on any transition from mono to stereo.
1912 They are also not included in an LBRR frame for the side channel, even if the
1913  LBRR flags indicate the corresponding mid channel was not coded.
1914 In that case, the previous weights are used, again substituting in zeros if no
1915  previous weights are available since the last decoder reset
1916  (see <xref target="decoder-reset"/>).
1917 </t>
1918
1919 <t>
1920 To summarize, these weights are coded if and only if
1921 <list style="symbols">
1922 <t>This is a stereo Opus frame (<xref target="toc_byte"/>), and</t>
1923 <t>The current SILK frame corresponds to the mid channel.</t>
1924 </list>
1925 </t>
1926
1927 <t>
1928 The prediction weights are coded in three separate pieces, which are decoded
1929  by silk_stereo_decode_pred() (decode_stereo_pred.c).
1930 The first piece jointly codes the high-order part of a table index for both
1931  weights.
1932 The second piece codes the low-order part of each table index.
1933 The third piece codes an offset used to linearly interpolate between table
1934  indices.
1935 The details are as follows.
1936 </t>
1937
1938 <t>
1939 Let n be an index decoded with the 25-element stage-1 PDF in
1940  <xref target="silk_stereo_pred_pdfs"/>.
1941 Then let i0 and i1 be indices decoded with the stage-2 and stage-3 PDFs in
1942  <xref target="silk_stereo_pred_pdfs"/>, respectively, and let i2 and i3
1943  be two more indices decoded with the stage-2 and stage-3 PDFs, all in that
1944  order.
1945 </t>
1946
1947 <texttable anchor="silk_stereo_pred_pdfs" title="Stereo Weight PDFs">
1948 <ttcol align="left">Stage</ttcol>
1949 <ttcol align="left">PDF</ttcol>
1950 <c>Stage 1</c>
1951 <c>{7,  2,  1,  1,  1,
1952    10, 24,  8,  1,  1,
1953     3, 23, 92, 23,  3,
1954     1,  1,  8, 24, 10,
1955     1,  1,  1,  2,  7}/256</c>
1956
1957 <c>Stage 2</c>
1958 <c>{85, 86, 85}/256</c>
1959
1960 <c>Stage 3</c>
1961 <c>{51, 51, 52, 51, 51}/256</c>
1962 </texttable>
1963
1964 <t>
1965 Then use n, i0, and i2 to form two table indices, wi0 and wi1, according to
1966 <figure align="center">
1967 <artwork align="center"><![CDATA[
1968 wi0 = i0 + 3*(n/5)
1969 wi1 = i2 + 3*(n%5)
1970 ]]></artwork>
1971 </figure>
1972  where the division is exact integer division.
1973 The range of these indices is 0 to 14, inclusive.
1974 Let w[i] be the i'th weight from <xref target="silk_stereo_weights_table"/>.
1975 Then the two prediction weights, w0_Q13 and w1_Q13, are
1976 <figure align="center">
1977 <artwork align="center"><![CDATA[
1978 w1_Q13 = w_Q13[wi1]
1979          + ((w_Q13[wi1+1] - w_Q13[wi1])*6554) >> 16)*(2*i3 + 1)
1980
1981 w0_Q13 = w_Q13[wi0]
1982          + ((w_Q13[wi0+1] - w_Q13[wi0])*6554) >> 16)*(2*i1 + 1)
1983          - w1_Q13
1984 ]]></artwork>
1985 </figure>
1986 N.b., w1_Q13 is computed first here, because w0_Q13 depends on it.
1987 The constant 6554 is approximately 0.1 in Q16.
1988 </t>
1989
1990 <texttable anchor="silk_stereo_weights_table"
1991  title="Stereo Weight Table">
1992 <ttcol align="left">Index</ttcol>
1993 <ttcol align="right">Weight (Q13)</ttcol>
1994  <c>0</c> <c>-13732</c>
1995  <c>1</c> <c>-10050</c>
1996  <c>2</c>  <c>-8266</c>
1997  <c>3</c>  <c>-7526</c>
1998  <c>4</c>  <c>-6500</c>
1999  <c>5</c>  <c>-5000</c>
2000  <c>6</c>  <c>-2950</c>
2001  <c>7</c>   <c>-820</c>
2002  <c>8</c>    <c>820</c>
2003  <c>9</c>   <c>2950</c>
2004 <c>10</c>   <c>5000</c>
2005 <c>11</c>   <c>6500</c>
2006 <c>12</c>   <c>7526</c>
2007 <c>13</c>   <c>8266</c>
2008 <c>14</c>  <c>10050</c>
2009 <c>15</c>  <c>13732</c>
2010 </texttable>
2011
2012 </section>
2013
2014 <section anchor="silk_mid_only_flag" toc="include" title="Mid-only Flag">
2015 <t>
2016 A flag appears after the stereo prediction weights that indicates if only the
2017  mid channel is coded for this time interval.
2018 It appears only when
2019 <list style="symbols">
2020 <t>This is a stereo Opus frame (see <xref target="toc_byte"/>),</t>
2021 <t>The current SILK frame corresponds to the mid channel, and</t>
2022 <t>Either
2023 <list style="symbols">
2024 <t>This is a regular SILK frame where the VAD flags
2025  (see <xref target="silk_header_bits"/>) indicate that the corresponding side
2026  channel is not active.</t>
2027 <t>
2028 This is an LBRR frame where the LBRR flags
2029  (see <xref target="silk_header_bits"/> and <xref target="silk_lbrr_flags"/>)
2030  indicate that the corresponding side channel is not coded.
2031 </t>
2032 </list>
2033 </t>
2034 </list>
2035 It is omitted when there are no stereo weights, for all of the same reasons.
2036 It is also omitted for a regular SILK frame when the VAD flag of the
2037  corresponding side channel frame is set (indicating it is active).
2038 The side channel must be coded in this case, making the mid-only flag
2039  redundant.
2040 It is also omitted for an LBRR frame when the corresponding LBRR flags
2041  indicate the side channel is coded.
2042 </t>
2043
2044 <t>
2045 When the flag is present, the decoder reads a single value using the PDF in
2046  <xref target="silk_mid_only_pdf"/>, as implemented in
2047  silk_stereo_decode_mid_only() (decode_stereo_pred.c).
2048 If the flag is set, then there is no corresponding SILK frame for the side
2049  channel, the entire decoding process for the side channel is skipped, and
2050  zeros are fed to the stereo unmixing process (see
2051  <xref target="silk_stereo_unmixing"/>) instead.
2052 As stated above, LBRR frames still include this flag when the LBRR flag
2053  indicates that the side channel is not coded.
2054 In that case, if this flag is zero (indicating that there should be a side
2055  channel), then Packet Loss Concealment (PLC, see
2056  <xref target="Packet Loss Concealment"/>) SHOULD be invoked to recover a
2057  side channel signal.
2058 </t>
2059
2060 <texttable anchor="silk_mid_only_pdf" title="Mid-only Flag PDF">
2061 <ttcol align="left">PDF</ttcol>
2062 <c>{192, 64}/256</c>
2063 </texttable>
2064
2065 </section>
2066
2067 <section anchor="silk_frame_type" toc="include" title="Frame Type">
2068 <t>
2069 Each SILK frame contains a single "frame type" symbol that jointly codes the
2070  signal type and quantization offset type of the corresponding frame.
2071 If the current frame is a regular SILK frame whose VAD bit was not set (an
2072  "inactive" frame), then the frame type symbol takes on a value of either 0 or
2073  1 and is decoded using the first PDF in <xref target="silk_frame_type_pdfs"/>.
2074 If the frame is an LBRR frame or a regular SILK frame whose VAD flag was set
2075  (an "active" frame), then the value of the symbol may range from 2 to 5,
2076  inclusive, and is decoded using the second PDF in
2077  <xref target="silk_frame_type_pdfs"/>.
2078 <xref target="silk_frame_type_table"/> translates between the value of the
2079  frame type symbol and the corresponding signal type and quantization offset
2080  type.
2081 </t>
2082
2083 <texttable anchor="silk_frame_type_pdfs" title="Frame Type PDFs">
2084 <ttcol>VAD Flag</ttcol>
2085 <ttcol>PDF</ttcol>
2086 <c>Inactive</c> <c>{26, 230, 0, 0, 0, 0}/256</c>
2087 <c>Active</c>   <c>{0, 0, 24, 74, 148, 10}/256</c>
2088 </texttable>
2089
2090 <texttable anchor="silk_frame_type_table"
2091  title="Signal Type and Quantization Offset Type from Frame Type">
2092 <ttcol>Frame Type</ttcol>
2093 <ttcol>Signal Type</ttcol>
2094 <ttcol align="right">Quantization Offset Type</ttcol>
2095 <c>0</c> <c>Inactive</c> <c>Low</c>
2096 <c>1</c> <c>Inactive</c> <c>High</c>
2097 <c>2</c> <c>Unvoiced</c> <c>Low</c>
2098 <c>3</c> <c>Unvoiced</c> <c>High</c>
2099 <c>4</c> <c>Voiced</c>   <c>Low</c>
2100 <c>5</c> <c>Voiced</c>   <c>High</c>
2101 </texttable>
2102
2103 </section>
2104
2105 <section anchor="silk_gains" toc="include" title="Subframe Gains">
2106 <t>
2107 A separate quantization gain is coded for each 5&nbsp;ms subframe.
2108 These gains control the step size between quantization levels of the excitation
2109  signal and, therefore, the quality of the reconstruction.
2110 They are independent of and unrelated to the pitch contours coded for voiced
2111  frames.
2112 The quantization gains are themselves uniformly quantized to 6&nbsp;bits on a
2113  log scale, giving them a resolution of approximately 1.369&nbsp;dB and a range
2114  of approximately 1.94&nbsp;dB to 88.21&nbsp;dB.
2115 </t>
2116 <t>
2117 The subframe gains are either coded independently, or relative to the gain from
2118  the most recent coded subframe in the same channel.
2119 Independent coding is used if and only if
2120 <list style="symbols">
2121 <t>
2122 This is the first subframe in the current SILK frame, and
2123 </t>
2124 <t>Either
2125 <list style="symbols">
2126 <t>
2127 This is the first SILK frame of its type (LBRR or regular) for this channel in
2128  the current Opus frame, or
2129  </t>
2130 <t>
2131 The previous SILK frame of the same type (LBRR or regular) for this channel in
2132  the same Opus frame was not coded.
2133 </t>
2134 </list>
2135 </t>
2136 </list>
2137 </t>
2138
2139 <t>
2140 In an independently coded subframe gain, the 3 most significant bits of the
2141  quantization gain are decoded using a PDF selected from
2142  <xref target="silk_independent_gain_msb_pdfs"/> based on the decoded signal
2143  type (see <xref target="silk_frame_type"/>).
2144 </t>
2145
2146 <texttable anchor="silk_independent_gain_msb_pdfs"
2147  title="PDFs for Independent Quantization Gain MSB Coding">
2148 <ttcol align="left">Signal Type</ttcol>
2149 <ttcol align="left">PDF</ttcol>
2150 <c>Inactive</c> <c>{32, 112, 68, 29, 12,  1,  1, 1}/256</c>
2151 <c>Unvoiced</c>  <c>{2,  17, 45, 60, 62, 47, 19, 4}/256</c>
2152 <c>Voiced</c>    <c>{1,   3, 26, 71, 94, 50,  9, 2}/256</c>
2153 </texttable>
2154
2155 <t>
2156 The 3 least significant bits are decoded using a uniform PDF:
2157 </t>
2158 <texttable anchor="silk_independent_gain_lsb_pdf"
2159  title="PDF for Independent Quantization Gain LSB Coding">
2160 <ttcol align="left">PDF</ttcol>
2161 <c>{32, 32, 32, 32, 32, 32, 32, 32}/256</c>
2162 </texttable>
2163
2164 <t>
2165 These 6 bits are combined to form a gain index between 0 and 63.
2166 When the gain for the previous subframe is available, then the current gain is
2167  limited as follows:
2168 <figure align="center">
2169 <artwork align="center"><![CDATA[
2170 log_gain = max(gain_index, previous_log_gain - 16) .
2171 ]]></artwork>
2172 </figure>
2173 This may help some implementations limit the change in precision of their
2174  internal LTP history.
2175 The indices which this clamp applies to cannot simply be removed from the
2176  codebook, because the previous gain index will not be available after packet
2177  loss.
2178 This step is skipped after a decoder reset, and in the side channel if the
2179  previous frame in the side channel was not coded, since there is no previous
2180  gain index.
2181 It MAY also be skipped after packet loss.
2182 </t>
2183
2184 <t>
2185 For subframes which do not have an independent gain (including the first
2186  subframe of frames not listed as using independent coding above), the
2187  quantization gain is coded relative to the gain from the previous subframe (in
2188  the same channel).
2189 The PDF in <xref target="silk_delta_gain_pdf"/> yields a delta gain index
2190  between 0 and 40, inclusive.
2191 </t>
2192 <texttable anchor="silk_delta_gain_pdf"
2193  title="PDF for Delta Quantization Gain Coding">
2194 <ttcol align="left">PDF</ttcol>
2195 <c>{6,   5,  11,  31, 132,  21,   8,   4,
2196     3,   2,   2,   2,   1,   1,   1,   1,
2197     1,   1,   1,   1,   1,   1,   1,   1,
2198     1,   1,   1,   1,   1,   1,   1,   1,
2199     1,   1,   1,   1,   1,   1,   1,   1,   1}/256</c>
2200 </texttable>
2201 <t>
2202 The following formula translates this index into a quantization gain for the
2203  current subframe using the gain from the previous subframe:
2204 <figure align="center">
2205 <artwork align="center"><![CDATA[
2206 log_gain = clamp(0, max(2*gain_index - 16,
2207                    previous_log_gain + gain_index - 4), 63) .
2208 ]]></artwork>
2209 </figure>
2210 </t>
2211 <t>
2212 silk_gains_dequant() (gain_quant.c) dequantizes log_gain for the k'th subframe
2213  and converts it into a linear Q16 scale factor via
2214 <figure align="center">
2215 <artwork align="center"><![CDATA[
2216 gain_Q16[k] = silk_log2lin((0x1D1C71*log_gain>>16) + 2090)
2217 ]]></artwork>
2218 </figure>
2219 </t>
2220 <t>
2221 The function silk_log2lin() (log2lin.c) computes an approximation of
2222  2**(inLog_Q7/128.0), where inLog_Q7 is its Q7 input.
2223 Let i = inLog_Q7&gt;&gt;7 be the integer part of inLogQ7 and
2224  f = inLog_Q7&amp;127 be the fractional part.
2225 Then
2226 <figure align="center">
2227 <artwork align="center"><![CDATA[
2228 (1<<i) + ((-174*f*(128-f)>>16)+f)*((1<<i)>>7)
2229 ]]></artwork>
2230 </figure>
2231  yields the approximate exponential.
2232 The final Q16 gain values lies between 81920 and 1686110208, inclusive
2233  (representing scale factors of 1.25 to 25728, respectively).
2234 </t>
2235 </section>
2236
2237 <section anchor="silk_nlsfs" toc="include" title="Normalized Line Spectral
2238  Frequency (LSF) and Linear Predictive Coding (LPC) Coefficients">
2239 <t>
2240 A set of normalized Line Spectral Frequency (LSF) coefficients follow the
2241  quantization gains in the bitstream, and represent the Linear Predictive
2242  Coding (LPC) coefficients for the current SILK frame.
2243 Once decoded, the normalized LSFs form an increasing list of Q15 values between
2244  0 and 1.
2245 These represent the interleaved zeros on the unit circle between 0 and pi
2246  (hence "normalized") in the standard decomposition of the LPC filter into a
2247  symmetric part and an anti-symmetric part (P and Q in
2248  <xref target="silk_nlsf2lpc"/>).
2249 Because of non-linear effects in the decoding process, an implementation SHOULD
2250  match the fixed-point arithmetic described in this section exactly.
2251 An encoder SHOULD also use the same process.
2252 </t>
2253 <t>
2254 The normalized LSFs are coded using a two-stage vector quantizer (VQ)
2255  (<xref target="silk_nlsf_stage1"/> and <xref target="silk_nlsf_stage2"/>).
2256 NB and MB frames use an order-10 predictor, while WB frames use an order-16
2257  predictor, and thus have different sets of tables.
2258 After reconstructing the normalized LSFs
2259  (<xref target="silk_nlsf_reconstruction"/>), the decoder runs them through a
2260  stabilization process (<xref target="silk_nlsf_stabilization"/>), interpolates
2261  them between frames (<xref target="silk_nlsf_interpolation"/>), converts them
2262  back into LPC coefficients (<xref target="silk_nlsf2lpc"/>), and then runs
2263  them through further processes to limit the range of the coefficients
2264  (<xref target="silk_lpc_range_limit"/>) and the gain of the filter
2265  (<xref target="silk_lpc_gain_limit"/>).
2266 All of this is necessary to ensure the reconstruction process is stable.
2267 </t>
2268
2269 <section anchor="silk_nlsf_stage1" title="Stage 1 Normalized LSF Decoding">
2270 <t>
2271 The first VQ stage uses a 32-element codebook, coded with one of the PDFs in
2272  <xref target="silk_nlsf_stage1_pdfs"/>, depending on the audio bandwidth and
2273  the signal type of the current SILK frame.
2274 This yields a single index, I1, for the entire frame.
2275 This indexes an element in a coarse codebook, selects the PDFs for the
2276  second stage of the VQ, and selects the prediction weights used to remove
2277  intra-frame redundancy from the second stage.
2278 The actual codebook elements are listed in
2279  <xref target="silk_nlsf_nbmb_codebook"/> and
2280  <xref target="silk_nlsf_wb_codebook"/>, but they are not needed until the last
2281  stages of reconstructing the LSF coefficients.
2282 </t>
2283
2284 <texttable anchor="silk_nlsf_stage1_pdfs"
2285  title="PDFs for Normalized LSF Index Stage-1 Decoding">
2286 <ttcol align="left">Audio Bandwidth</ttcol>
2287 <ttcol align="left">Signal Type</ttcol>
2288 <ttcol align="left">PDF</ttcol>
2289 <c>NB or MB</c> <c>Inactive or unvoiced</c>
2290 <c>
2291 {44, 34, 30, 19, 21, 12, 11,  3,
2292   3,  2, 16,  2,  2,  1,  5,  2,
2293   1,  3,  3,  1,  1,  2,  2,  2,
2294   3,  1,  9,  9,  2,  7,  2,  1}/256
2295 </c>
2296 <c>NB or MB</c> <c>Voiced</c>
2297 <c>
2298 {1, 10,  1,  8,  3,  8,  8, 14,
2299 13, 14,  1, 14, 12, 13, 11, 11,
2300 12, 11, 10, 10, 11,  8,  9,  8,
2301  7,  8,  1,  1,  6,  1,  6,  5}/256
2302 </c>
2303 <c>WB</c> <c>Inactive or unvoiced</c>
2304 <c>
2305 {31, 21,  3, 17,  1,  8, 17,  4,
2306   1, 18, 16,  4,  2,  3,  1, 10,
2307   1,  3, 16, 11, 16,  2,  2,  3,
2308   2, 11,  1,  4,  9,  8,  7,  3}/256
2309 </c>
2310 <c>WB</c> <c>Voiced</c>
2311 <c>
2312 {1,  4, 16,  5, 18, 11,  5, 14,
2313 15,  1,  3, 12, 13, 14, 14,  6,
2314 14, 12,  2,  6,  1, 12, 12, 11,
2315 10,  3, 10,  5,  1,  1,  1,  3}/256
2316 </c>
2317 </texttable>
2318
2319 </section>
2320
2321 <section anchor="silk_nlsf_stage2" title="Stage 2 Normalized LSF Decoding">
2322 <t>
2323 A total of 16 PDFs are available for the LSF residual in the second stage: the
2324  8 (a...h) for NB and MB frames given in
2325  <xref target="silk_nlsf_stage2_nbmb_pdfs"/>, and the 8 (i...p) for WB frames
2326  given in <xref target="silk_nlsf_stage2_wb_pdfs"/>.
2327 Which PDF is used for which coefficient is driven by the index, I1,
2328  decoded in the first stage.
2329 <xref target="silk_nlsf_nbmb_stage2_cb_sel"/> lists the letter of the
2330  corresponding PDF for each normalized LSF coefficient for NB and MB, and
2331  <xref target="silk_nlsf_wb_stage2_cb_sel"/> lists the same information for WB.
2332 </t>
2333
2334 <texttable anchor="silk_nlsf_stage2_nbmb_pdfs"
2335  title="PDFs for NB/MB Normalized LSF Index Stage-2 Decoding">
2336 <ttcol align="left">Codebook</ttcol>
2337 <ttcol align="left">PDF</ttcol>
2338 <c>a</c> <c>{1,   1,   1,  15, 224,  11,   1,   1,   1}/256</c>
2339 <c>b</c> <c>{1,   1,   2,  34, 183,  32,   1,   1,   1}/256</c>
2340 <c>c</c> <c>{1,   1,   4,  42, 149,  55,   2,   1,   1}/256</c>
2341 <c>d</c> <c>{1,   1,   8,  52, 123,  61,   8,   1,   1}/256</c>
2342 <c>e</c> <c>{1,   3,  16,  53, 101,  74,   6,   1,   1}/256</c>
2343 <c>f</c> <c>{1,   3,  17,  55,  90,  73,  15,   1,   1}/256</c>
2344 <c>g</c> <c>{1,   7,  24,  53,  74,  67,  26,   3,   1}/256</c>
2345 <c>h</c> <c>{1,   1,  18,  63,  78,  58,  30,   6,   1}/256</c>
2346 </texttable>
2347
2348 <texttable anchor="silk_nlsf_stage2_wb_pdfs"
2349  title="PDFs for WB Normalized LSF Index Stage-2 Decoding">
2350 <ttcol align="left">Codebook</ttcol>
2351 <ttcol align="left">PDF</ttcol>
2352 <c>i</c> <c>{1,   1,   1,   9, 232,   9,   1,   1,   1}/256</c>
2353 <c>j</c> <c>{1,   1,   2,  28, 186,  35,   1,   1,   1}/256</c>
2354 <c>k</c> <c>{1,   1,   3,  42, 152,  53,   2,   1,   1}/256</c>
2355 <c>l</c> <c>{1,   1,  10,  49, 126,  65,   2,   1,   1}/256</c>
2356 <c>m</c> <c>{1,   4,  19,  48, 100,  77,   5,   1,   1}/256</c>
2357 <c>n</c> <c>{1,   1,  14,  54, 100,  72,  12,   1,   1}/256</c>
2358 <c>o</c> <c>{1,   1,  15,  61,  87,  61,  25,   4,   1}/256</c>
2359 <c>p</c> <c>{1,   7,  21,  50,  77,  81,  17,   1,   1}/256</c>
2360 </texttable>
2361
2362 <texttable anchor="silk_nlsf_nbmb_stage2_cb_sel"
2363  title="Codebook Selection for NB/MB Normalized LSF Index Stage 2 Decoding">
2364 <ttcol>I1</ttcol>
2365 <ttcol>Coefficient</ttcol>
2366 <c/>
2367 <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>
2368 <c> 0</c>
2369 <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>
2370 <c> 1</c>
2371 <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>
2372 <c> 2</c>
2373 <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>
2374 <c> 3</c>
2375 <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>
2376 <c> 4</c>
2377 <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>
2378 <c> 5</c>
2379 <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>
2380 <c> g</c>
2381 <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>
2382 <c> 7</c>
2383 <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>
2384 <c> 8</c>
2385 <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>
2386 <c> 9</c>
2387 <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>
2388 <c>10</c>
2389 <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>
2390 <c>11</c>
2391 <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>
2392 <c>12</c>
2393 <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>
2394 <c>13</c>
2395 <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>
2396 <c>14</c>
2397 <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>
2398 <c>15</c>
2399 <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>
2400 <c>16</c>
2401 <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>
2402 <c>17</c>
2403 <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>
2404 <c>18</c>
2405 <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>
2406 <c>19</c>
2407 <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>
2408 <c>20</c>
2409 <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>
2410 <c>21</c>
2411 <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>
2412 <c>22</c>
2413 <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>
2414 <c>23</c>
2415 <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>
2416 <c>24</c>
2417 <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>
2418 <c>25</c>
2419 <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>
2420 <c>26</c>
2421 <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>
2422 <c>27</c>
2423 <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>
2424 <c>28</c>
2425 <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>
2426 <c>29</c>
2427 <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>
2428 <c>30</c>
2429 <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>
2430 <c>31</c>
2431 <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>
2432 </texttable>
2433
2434 <texttable anchor="silk_nlsf_wb_stage2_cb_sel"
2435  title="Codebook Selection for WB Normalized LSF Index Stage 2 Decoding">
2436 <ttcol>I1</ttcol>
2437 <ttcol>Coefficient</ttcol>
2438 <c/>
2439 <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>
2440 <c> 0</c>
2441 <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>
2442 <c> 1</c>
2443 <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>
2444 <c> 2</c>
2445 <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>
2446 <c> 3</c>
2447 <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>
2448 <c> 4</c>
2449 <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>
2450 <c> 5</c>
2451 <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>
2452 <c> 6</c>
2453 <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>
2454 <c> 7</c>
2455 <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>
2456 <c> 8</c>
2457 <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>
2458 <c> 9</c>
2459 <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>
2460 <c>10</c>
2461 <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>
2462 <c>11</c>
2463 <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>
2464 <c>12</c>
2465 <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>
2466 <c>13</c>
2467 <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>
2468 <c>14</c>
2469 <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>
2470 <c>15</c>
2471 <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>
2472 <c>16</c>
2473 <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>
2474 <c>17</c>
2475 <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>
2476 <c>18</c>
2477 <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>
2478 <c>19</c>
2479 <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>
2480 <c>20</c>
2481 <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>
2482 <c>21</c>
2483 <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>
2484 <c>22</c>
2485 <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>
2486 <c>23</c>
2487 <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>
2488 <c>24</c>
2489 <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>
2490 <c>25</c>
2491 <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>
2492 <c>26</c>
2493 <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>
2494 <c>27</c>
2495 <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>
2496 <c>28</c>
2497 <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>
2498 <c>29</c>
2499 <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>
2500 <c>30</c>
2501 <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>
2502 <c>31</c>
2503 <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>
2504 </texttable>
2505
2506 <t>
2507 Decoding the second stage residual proceeds as follows.
2508 For each coefficient, the decoder reads a symbol using the PDF corresponding to
2509  I1 from either <xref target="silk_nlsf_nbmb_stage2_cb_sel"/> or
2510  <xref target="silk_nlsf_wb_stage2_cb_sel"/>, and subtracts 4 from the result
2511  to give an index in the range -4 to 4, inclusive.
2512 If the index is either -4 or 4, it reads a second symbol using the PDF in
2513  <xref target="silk_nlsf_ext_pdf"/>, and adds the value of this second symbol
2514  to the index, using the same sign.
2515 This gives the index, I2[k], a total range of -10 to 10, inclusive.
2516 </t>
2517
2518 <texttable anchor="silk_nlsf_ext_pdf"
2519  title="PDF for Normalized LSF Index Extension Decoding">
2520 <ttcol align="left">PDF</ttcol>
2521 <c>{156, 60, 24,  9,  4,  2,  1}/256</c>
2522 </texttable>
2523
2524 <t>
2525 The decoded indices from both stages are translated back into normalized LSF
2526  coefficients in silk_NLSF_decode() (NLSF_decode.c).
2527 The stage-2 indices represent residuals after both the first stage of the VQ
2528  and a separate backwards-prediction step.
2529 The backwards prediction process in the encoder subtracts a prediction from
2530  each residual formed by a multiple of the coefficient that follows it.
2531 The decoder must undo this process.
2532 <xref target="silk_nlsf_pred_weights"/> contains lists of prediction weights
2533  for each coefficient.
2534 There are two lists for NB and MB, and another two lists for WB, giving two
2535  possible prediction weights for each coefficient.
2536 </t>
2537
2538 <texttable anchor="silk_nlsf_pred_weights"
2539  title="Prediction Weights for Normalized LSF Decoding">
2540 <ttcol align="left">Coefficient</ttcol>
2541 <ttcol align="right">A</ttcol>
2542 <ttcol align="right">B</ttcol>
2543 <ttcol align="right">C</ttcol>
2544 <ttcol align="right">D</ttcol>
2545  <c>0</c> <c>179</c> <c>116</c> <c>175</c>  <c>68</c>
2546  <c>1</c> <c>138</c>  <c>67</c> <c>148</c>  <c>62</c>
2547  <c>2</c> <c>140</c>  <c>82</c> <c>160</c>  <c>66</c>
2548  <c>3</c> <c>148</c>  <c>59</c> <c>176</c>  <c>60</c>
2549  <c>4</c> <c>151</c>  <c>92</c> <c>178</c>  <c>72</c>
2550  <c>5</c> <c>149</c>  <c>72</c> <c>173</c> <c>117</c>
2551  <c>6</c> <c>153</c> <c>100</c> <c>174</c>  <c>85</c>
2552  <c>7</c> <c>151</c>  <c>89</c> <c>164</c>  <c>90</c>
2553  <c>8</c> <c>163</c>  <c>92</c> <c>177</c> <c>118</c>
2554  <c>9</c> <c/>        <c/>      <c>174</c> <c>136</c>
2555 <c>10</c> <c/>        <c/>      <c>196</c> <c>151</c>
2556 <c>11</c> <c/>        <c/>      <c>182</c> <c>142</c>
2557 <c>12</c> <c/>        <c/>      <c>198</c> <c>160</c>
2558 <c>13</c> <c/>        <c/>      <c>192</c> <c>142</c>
2559 <c>14</c> <c/>        <c/>      <c>182</c> <c>155</c>
2560 </texttable>
2561
2562 <t>
2563 The prediction is undone using the procedure implemented in
2564  silk_NLSF_residual_dequant() (NLSF_decode.c), which is as follows.
2565 Each coefficient selects its prediction weight from one of the two lists based
2566  on the stage-1 index, I1.
2567 <xref target="silk_nlsf_nbmb_weight_sel"/> gives the selections for each
2568  coefficient for NB and MB, and <xref target="silk_nlsf_wb_weight_sel"/> gives
2569  the selections for WB.
2570 Let d_LPC be the order of the codebook, i.e., 10 for NB and MB, and 16 for WB,
2571  and let pred_Q8[k] be the weight for the k'th coefficient selected by this
2572  process for 0&nbsp;&lt;=&nbsp;k&nbsp;&lt;&nbsp;d_LPC-1.
2573 Then, the stage-2 residual for each coefficient is computed via
2574 <figure align="center">
2575 <artwork align="center"><![CDATA[
2576 res_Q10[k] = (k+1 < d_LPC ? (res_Q10[k+1]*pred_Q8[k])>>8 : 0)
2577              + ((((I2[k]<<10) - sign(I2[k])*102)*qstep)>>16) ,
2578 ]]></artwork>
2579 </figure>
2580  where qstep is the Q16 quantization step size, which is 11796 for NB and MB
2581  and 9830 for WB (representing step sizes of approximately 0.18 and 0.15,
2582  respectively).
2583 </t>
2584
2585 <texttable anchor="silk_nlsf_nbmb_weight_sel"
2586  title="Prediction Weight Selection for NB/MB Normalized LSF Decoding">
2587 <ttcol>I1</ttcol>
2588 <ttcol>Coefficient</ttcol>
2589 <c/>
2590 <c><spanx style="vbare">0&nbsp;1&nbsp;2&nbsp;3&nbsp;4&nbsp;5&nbsp;6&nbsp;7&nbsp;8</spanx></c>
2591 <c> 0</c>
2592 <c><spanx style="vbare">A&nbsp;B&nbsp;A&nbsp;A&nbsp;A&nbsp;A&nbsp;A&nbsp;A&nbsp;A</spanx></c>
2593 <c> 1</c>
2594 <c><spanx style="vbare">B&nbsp;A&nbsp;A&nbsp;A&nbsp;A&nbsp;A&nbsp;A&nbsp;A&nbsp;A</spanx></c>
2595 <c> 2</c>
2596 <c><spanx style="vbare">A&nbsp;A&nbsp;A&nbsp;A&nbsp;A&nbsp;A&nbsp;A&nbsp;A&nbsp;A</spanx></c>
2597 <c> 3</c>
2598 <c><spanx style="vbare">B&nbsp;B&nbsp;B&nbsp;A&nbsp;A&nbsp;A&nbsp;A&nbsp;B&nbsp;A</spanx></c>
2599 <c> 4</c>
2600 <c><spanx style="vbare">A&nbsp;B&nbsp;A&nbsp;A&nbsp;A&nbsp;A&nbsp;A&nbsp;A&nbsp;A</spanx></c>
2601 <c> 5</c>
2602 <c><spanx style="vbare">A&nbsp;B&nbsp;A&nbsp;A&nbsp;A&nbsp;A&nbsp;A&nbsp;A&nbsp;A</spanx></c>
2603 <c> 6</c>
2604 <c><spanx style="vbare">B&nbsp;A&nbsp;B&nbsp;B&nbsp;A&nbsp;A&nbsp;A&nbsp;B&nbsp;A</spanx></c>
2605 <c> 7</c>
2606 <c><spanx style="vbare">A&nbsp;B&nbsp;B&nbsp;A&nbsp;A&nbsp;B&nbsp;B&nbsp;A&nbsp;A</spanx></c>
2607 <c> 8</c>
2608 <c><spanx style="vbare">A&nbsp;A&nbsp;B&nbsp;B&nbsp;A&nbsp;B&nbsp;A&nbsp;B&nbsp;B</spanx></c>
2609 <c> 9</c>
2610 <c><spanx style="vbare">A&nbsp;A&nbsp;B&nbsp;B&nbsp;A&nbsp;A&nbsp;B&nbsp;B&nbsp;B</spanx></c>
2611 <c>10</c>
2612 <c><spanx style="vbare">A&nbsp;A&nbsp;A&nbsp;A&nbsp;A&nbsp;A&nbsp;A&nbsp;A&nbsp;A</spanx></c>
2613 <c>11</c>
2614 <c><spanx style="vbare">A&nbsp;B&nbsp;A&nbsp;B&nbsp;B&nbsp;B&nbsp;B&nbsp;B&nbsp;A</spanx></c>
2615 <c>12</c>
2616 <c><spanx style="vbare">A&nbsp;B&nbsp;A&nbsp;B&nbsp;B&nbsp;B&nbsp;B&nbsp;B&nbsp;A</spanx></c>
2617 <c>13</c>
2618 <c><spanx style="vbare">A&nbsp;B&nbsp;B&nbsp;B&nbsp;B&nbsp;B&nbsp;B&nbsp;B&nbsp;A</spanx></c>
2619 <c>14</c>
2620 <c><spanx style="vbare">B&nbsp;A&nbsp;B&nbsp;B&nbsp;A&nbsp;B&nbsp;B&nbsp;B&nbsp;B</spanx></c>
2621 <c>15</c>
2622 <c><spanx style="vbare">A&nbsp;B&nbsp;B&nbsp;B&nbsp;B&nbsp;B&nbsp;A&nbsp;B&nbsp;A</spanx></c>
2623 <c>16</c>
2624 <c><spanx style="vbare">A&nbsp;A&nbsp;B&nbsp;B&nbsp;A&nbsp;B&nbsp;A&nbsp;B&nbsp;A</spanx></c>
2625 <c>17</c>
2626 <c><spanx style="vbare">A&nbsp;A&nbsp;B&nbsp;B&nbsp;B&nbsp;A&nbsp;B&nbsp;B&nbsp;B</spanx></c>
2627 <c>18</c>
2628 <c><spanx style="vbare">A&nbsp;B&nbsp;B&nbsp;A&nbsp;A&nbsp;B&nbsp;B&nbsp;B&nbsp;A</spanx></c>
2629 <c>19</c>
2630 <c><spanx style="vbare">A&nbsp;A&nbsp;A&nbsp;B&nbsp;B&nbsp;B&nbsp;A&nbsp;B&nbsp;A</spanx></c>
2631 <c>20</c>
2632 <c><spanx style="vbare">A&nbsp;B&nbsp;B&nbsp;A&nbsp;A&nbsp;B&nbsp;A&nbsp;B&nbsp;A</spanx></c>
2633 <c>21</c>
2634 <c><spanx style="vbare">A&nbsp;B&nbsp;B&nbsp;A&nbsp;A&nbsp;A&nbsp;B&nbsp;B&nbsp;A</spanx></c>
2635 <c>22</c>
2636 <c><spanx style="vbare">A&nbsp;A&nbsp;A&nbsp;A&nbsp;A&nbsp;B&nbsp;B&nbsp;B&nbsp;B</spanx></c>
2637 <c>23</c>
2638 <c><spanx style="vbare">A&nbsp;A&nbsp;B&nbsp;B&nbsp;A&nbsp;A&nbsp;A&nbsp;B&nbsp;B</spanx></c>
2639 <c>24</c>
2640 <c><spanx style="vbare">A&nbsp;A&nbsp;A&nbsp;B&nbsp;A&nbsp;B&nbsp;B&nbsp;B&nbsp;B</spanx></c>
2641 <c>25</c>
2642 <c><spanx style="vbare">A&nbsp;B&nbsp;B&nbsp;B&nbsp;B&nbsp;B&nbsp;B&nbsp;B&nbsp;A</spanx></c>
2643 <c>26</c>
2644 <c><spanx style="vbare">A&nbsp;A&nbsp;A&nbsp;A&nbsp;A&nbsp;A&nbsp;A&nbsp;A&nbsp;A</spanx></c>
2645 <c>27</c>
2646 <c><spanx style="vbare">A&nbsp;A&nbsp;A&nbsp;A&nbsp;A&nbsp;A&nbsp;A&nbsp;A&nbsp;A</spanx></c>
2647 <c>28</c>
2648 <c><spanx style="vbare">A&nbsp;A&nbsp;B&nbsp;A&nbsp;B&nbsp;B&nbsp;A&nbsp;B&nbsp;A</spanx></c>
2649 <c>29</c>
2650 <c><spanx style="vbare">B&nbsp;A&nbsp;A&nbsp;B&nbsp;A&nbsp;A&nbsp;A&nbsp;A&nbsp;A</spanx></c>
2651 <c>30</c>
2652 <c><spanx style="vbare">A&nbsp;A&nbsp;A&nbsp;B&nbsp;B&nbsp;A&nbsp;B&nbsp;A&nbsp;B</spanx></c>
2653 <c>31</c>
2654 <c><spanx style="vbare">B&nbsp;A&nbsp;B&nbsp;B&nbsp;A&nbsp;B&nbsp;B&nbsp;B&nbsp;B</spanx></c>
2655 </texttable>
2656
2657 <texttable anchor="silk_nlsf_wb_weight_sel"
2658  title="Prediction Weight Selection for WB Normalized LSF Decoding">
2659 <ttcol>I1</ttcol>
2660 <ttcol>Coefficient</ttcol>
2661 <c/>
2662 <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>
2663 <c> 0</c>
2664 <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>
2665 <c> 1</c>
2666 <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>
2667 <c> 2</c>
2668 <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>
2669 <c> 3</c>
2670 <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>
2671 <c> 4</c>
2672 <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>
2673 <c> 5</c>
2674 <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;C&nbsp;&nbsp;C&nbsp;&nbsp;C&nbsp;&nbsp;C&nbsp;&nbsp;C&nbsp;&nbsp;C&nbsp;&nbsp;C&nbsp;&nbsp;C</spanx></c>
2675 <c> 6</c>
2676 <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>
2677 <c> 7</c>
2678 <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>
2679 <c> 8</c>
2680 <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>
2681 <c> 9</c>
2682 <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>
2683 <c>10</c>
2684 <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>
2685 <c>11</c>
2686 <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>
2687 <c>12</c>
2688 <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>
2689 <c>13</c>
2690 <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>
2691 <c>14</c>
2692 <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>
2693 <c>15</c>
2694 <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>
2695 <c>16</c>
2696 <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>
2697 <c>17</c>
2698 <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>
2699 <c>18</c>
2700 <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>
2701 <c>19</c>
2702 <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>
2703 <c>20</c>
2704 <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>
2705 <c>21</c>
2706 <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>
2707 <c>22</c>
2708 <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>
2709 <c>23</c>
2710 <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>
2711 <c>24</c>
2712 <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>
2713 <c>25</c>
2714 <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>
2715 <c>26</c>
2716 <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>
2717 <c>27</c>
2718 <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>
2719 <c>28</c>
2720 <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>
2721 <c>29</c>
2722 <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>
2723 <c>30</c>
2724 <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>
2725 <c>31</c>
2726 <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>
2727 </texttable>
2728
2729 </section>
2730
2731 <section anchor="silk_nlsf_reconstruction"
2732  title="Reconstructing the Normalized LSF Coefficients">
2733 <t>
2734 Once the stage-1 index I1 and the stage-2 residual res_Q10[] have been decoded,
2735  the final normalized LSF coefficients can be reconstructed.
2736 </t>
2737 <t>
2738 The spectral distortion introduced by the quantization of each LSF coefficient
2739  varies, so the stage-2 residual is weighted accordingly, using the
2740  low-complexity Inverse Harmonic Mean Weighting (IHMW) function proposed in
2741  <xref target="laroia-icassp"/>.
2742 The weights are derived directly from the stage-1 codebook vector.
2743 Let cb1_Q8[k] be the k'th entry of the stage-1 codebook vector from
2744  <xref target="silk_nlsf_nbmb_codebook"/> or
2745  <xref target="silk_nlsf_wb_codebook"/>.
2746 Then for 0&nbsp;&lt;=&nbsp;k&nbsp;&lt;&nbsp;d_LPC the following expression
2747  computes the square of the weight as a Q18 value:
2748 <figure align="center">
2749 <artwork align="center">
2750 <![CDATA[
2751 w2_Q18[k] = (1024/(cb1_Q8[k] - cb1_Q8[k-1])
2752              + 1024/(cb1_Q8[k+1] - cb1_Q8[k])) << 16 ,
2753 ]]>
2754 </artwork>
2755 </figure>
2756  where cb1_Q8[-1]&nbsp;=&nbsp;0 and cb1_Q8[d_LPC]&nbsp;=&nbsp;256, and the
2757  division is exact integer division.
2758 This is reduced to an unsquared, Q9 value using the following square-root
2759  approximation:
2760 <figure align="center">
2761 <artwork align="center"><![CDATA[
2762 i = ilog(w2_Q18[k])
2763 f = (w2_Q18[k]>>(i-8)) & 127
2764 y = ((i&1) ? 32768 : 46214) >> ((32-i)>>1)
2765 w_Q9[k] = y + ((213*f*y)>>16)
2766 ]]></artwork>
2767 </figure>
2768 The constant 46214 here is approximately the square root of 2 in Q15.
2769 The cb1_Q8[] vector completely determines these weights, and they may be
2770  tabulated and stored as 13-bit unsigned values (with a range of 1819 to 5227,
2771  inclusive) to avoid computing them when decoding.
2772 The reference implementation already requires code to compute these weights on
2773  unquantized coefficients in the encoder, in silk_NLSF_VQ_weights_laroia()
2774  (NLSF_VQ_weights_laroia.c) and its callers, so it reuses that code in the
2775  decoder instead of using a pre-computed table to reduce the amount of ROM
2776  required.
2777 </t>
2778
2779 <texttable anchor="silk_nlsf_nbmb_codebook"
2780            title="Codebook Vectors for NB/MB Normalized LSF Stage 1 Decoding">
2781 <ttcol>I1</ttcol>
2782 <ttcol>Codebook (Q8)</ttcol>
2783 <c/>
2784 <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>
2785 <c>0</c>
2786 <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>
2787 <c>1</c>
2788 <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>
2789 <c>2</c>
2790 <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>
2791 <c>3</c>
2792 <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>
2793 <c>4</c>
2794 <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>
2795 <c>5</c>
2796 <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>
2797 <c>6</c>
2798 <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>
2799 <c>7</c>
2800 <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>
2801 <c>8</c>
2802 <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>
2803 <c>9</c>
2804 <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>
2805 <c>10</c>
2806 <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>
2807 <c>11</c>
2808 <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>
2809 <c>12</c>
2810 <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>
2811 <c>13</c>
2812 <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>
2813 <c>14</c>
2814 <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>
2815 <c>15</c>
2816 <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>
2817 <c>16</c>
2818 <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>
2819 <c>17</c>
2820 <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>
2821 <c>18</c>
2822 <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>
2823 <c>19</c>
2824 <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>
2825 <c>20</c>
2826 <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>
2827 <c>21</c>
2828 <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>
2829 <c>22</c>
2830 <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>
2831 <c>23</c>
2832 <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>
2833 <c>24</c>
2834 <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>
2835 <c>25</c>
2836 <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>
2837 <c>26</c>
2838 <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>
2839 <c>27</c>
2840 <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>
2841 <c>28</c>
2842 <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>
2843 <c>29</c>
2844 <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>
2845 <c>30</c>
2846 <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>
2847 <c>31</c>
2848 <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>
2849 </texttable>
2850
2851 <texttable anchor="silk_nlsf_wb_codebook"
2852            title="Codebook Vectors for WB Normalized LSF Stage 1 Decoding">
2853 <ttcol>I1</ttcol>
2854 <ttcol>Codebook (Q8)</ttcol>
2855 <c/>
2856 <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>
2857 <c>0</c>
2858 <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>
2859 <c>1</c>
2860 <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>
2861 <c>2</c>
2862 <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>
2863 <c>3</c>
2864 <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>
2865 <c>4</c>
2866 <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>
2867 <c>5</c>
2868 <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>
2869 <c>6</c>
2870 <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>
2871 <c>7</c>
2872 <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>
2873 <c>8</c>
2874 <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>
2875 <c>9</c>
2876 <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>
2877 <c>10</c>
2878 <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>
2879 <c>11</c>
2880 <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>
2881 <c>12</c>
2882 <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>
2883 <c>13</c>
2884 <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>
2885 <c>14</c>
2886 <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>
2887 <c>15</c>
2888 <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>
2889 <c>16</c>
2890 <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>
2891 <c>17</c>
2892 <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>
2893 <c>18</c>
2894 <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>
2895 <c>19</c>
2896 <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>
2897 <c>20</c>
2898 <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>
2899 <c>21</c>
2900 <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>
2901 <c>22</c>
2902 <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>
2903 <c>23</c>
2904 <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>
2905 <c>24</c>
2906 <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>
2907 <c>25</c>
2908 <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>
2909 <c>26</c>
2910 <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>
2911 <c>27</c>
2912 <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>
2913 <c>28</c>
2914 <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>
2915 <c>29</c>
2916 <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>
2917 <c>30</c>
2918 <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>
2919 <c>31</c>
2920 <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>
2921 </texttable>
2922
2923 <t>
2924 Given the stage-1 codebook entry cb1_Q8[], the stage-2 residual res_Q10[], and
2925  their corresponding weights, w_Q9[], the reconstructed normalized LSF
2926  coefficients are
2927 <figure align="center">
2928 <artwork align="center"><![CDATA[
2929 NLSF_Q15[k] = clamp(0,
2930                (cb1_Q8[k]<<7) + (res_Q10[k]<<14)/w_Q9[k], 32767) ,
2931 ]]></artwork>
2932 </figure>
2933  where the division is exact integer division.
2934 However, nothing in either the reconstruction process or the
2935  quantization process in the encoder thus far guarantees that the coefficients
2936  are monotonically increasing and separated well enough to ensure a stable
2937  filter.
2938 When using the reference encoder, roughly 2% of frames violate this constraint.
2939 The next section describes a stabilization procedure used to make these
2940  guarantees.
2941 </t>
2942
2943 </section>
2944
2945 <section anchor="silk_nlsf_stabilization" title="Normalized LSF Stabilization">
2946 <t>
2947 The normalized LSF stabilization procedure is implemented in
2948  silk_NLSF_stabilize() (NLSF_stabilize.c).
2949 This process ensures that consecutive values of the normalized LSF
2950  coefficients, NLSF_Q15[], are spaced some minimum distance apart
2951  (predetermined to be the 0.01 percentile of a large training set).
2952 <xref target="silk_nlsf_min_spacing"/> gives the minimum spacings for NB and MB
2953  and those for WB, where row k is the minimum allowed value of
2954  NLSF_Q[k]-NLSF_Q[k-1].
2955 For the purposes of computing this spacing for the first and last coefficient,
2956  NLSF_Q15[-1] is taken to be 0, and NLSF_Q15[d_LPC] is taken to be 32768.
2957 </t>
2958
2959 <texttable anchor="silk_nlsf_min_spacing"
2960            title="Minimum Spacing for Normalized LSF Coefficients">
2961 <ttcol>Coefficient</ttcol>
2962 <ttcol align="right">NB and MB</ttcol>
2963 <ttcol align="right">WB</ttcol>
2964  <c>0</c> <c>250</c> <c>100</c>
2965  <c>1</c>   <c>3</c>   <c>3</c>
2966  <c>2</c>   <c>6</c>  <c>40</c>
2967  <c>3</c>   <c>3</c>   <c>3</c>
2968  <c>4</c>   <c>3</c>   <c>3</c>
2969  <c>5</c>   <c>3</c>   <c>3</c>
2970  <c>6</c>   <c>4</c>   <c>5</c>
2971  <c>7</c>   <c>3</c>  <c>14</c>
2972  <c>8</c>   <c>3</c>  <c>14</c>
2973  <c>9</c>   <c>3</c>  <c>10</c>
2974 <c>10</c> <c>461</c>  <c>11</c>
2975 <c>11</c>       <c/>   <c>3</c>
2976 <c>12</c>       <c/>   <c>8</c>
2977 <c>13</c>       <c/>   <c>9</c>
2978 <c>14</c>       <c/>   <c>7</c>
2979 <c>15</c>       <c/>   <c>3</c>
2980 <c>16</c>       <c/> <c>347</c>
2981 </texttable>
2982
2983 <t>
2984 The procedure starts off by trying to make small adjustments which attempt to
2985  minimize the amount of distortion introduced.
2986 After 20 such adjustments, it falls back to a more direct method which
2987  guarantees the constraints are enforced but may require large adjustments.
2988 </t>
2989 <t>
2990 Let NDeltaMin_Q15[k] be the minimum required spacing for the current audio
2991  bandwidth from <xref target="silk_nlsf_min_spacing"/>.
2992 First, the procedure finds the index i where
2993  NLSF_Q15[i]&nbsp;-&nbsp;NLSF_Q15[i-1]&nbsp;-&nbsp;NDeltaMin_Q15[i] is the
2994  smallest, breaking ties by using the lower value of i.
2995 If this value is non-negative, then the stabilization stops; the coefficients
2996  satisfy all the constraints.
2997 Otherwise, if i&nbsp;==&nbsp;0, it sets NLSF_Q15[0] to NDeltaMin_Q15[0], and if
2998  i&nbsp;==&nbsp;d_LPC, it sets NLSF_Q15[d_LPC-1] to
2999  (32768&nbsp;-&nbsp;NDeltaMin_Q15[d_LPC]).
3000 For all other values of i, both NLSF_Q15[i-1] and NLSF_Q15[i] are updated as
3001  follows:
3002 <figure align="center">
3003 <artwork align="center"><![CDATA[
3004                                       i-1
3005                                       __
3006  min_center_Q15 = (NDeltaMin[i]>>1) + \  NDeltaMin[k]
3007                                       /_
3008                                       k=0
3009                                              d_LPC
3010                                               __
3011  max_center_Q15 = 32768 - (NDeltaMin[i]>>1) - \  NDeltaMin[k]
3012                                               /_
3013                                              k=i+1
3014 center_freq_Q15 = clamp(min_center_Q15[i],
3015                         (NLSF_Q15[i-1] + NLSF_Q15[i] + 1)>>1,
3016                         max_center_Q15[i])
3017
3018  NLSF_Q15[i-1] = center_freq_Q15 - (NDeltaMin_Q15[i]>>1)
3019
3020    NLSF_Q15[i] = NLSF_Q15[i-1] + NDeltaMin_Q15[i] .
3021 ]]></artwork>
3022 </figure>
3023 Then the procedure repeats again, until it has either executed 20 times or
3024  has stopped because the coefficients satisfy all the constraints.
3025 </t>
3026 <t>
3027 After the 20th repetition of the above procedure, the following fallback
3028  procedure executes once.
3029 First, the values of NLSF_Q15[k] for 0&nbsp;&lt;=&nbsp;k&nbsp;&lt;&nbsp;d_LPC
3030  are sorted in ascending order.
3031 Then for each value of k from 0 to d_LPC-1, NLSF_Q15[k] is set to
3032 <figure align="center">
3033 <artwork align="center"><![CDATA[
3034 max(NLSF_Q15[k], NLSF_Q15[k-1] + NDeltaMin_Q15[k]) .
3035 ]]></artwork>
3036 </figure>
3037 Next, for each value of k from d_LPC-1 down to 0, NLSF_Q15[k] is set to
3038 <figure align="center">
3039 <artwork align="center"><![CDATA[
3040 min(NLSF_Q15[k], NLSF_Q15[k+1] - NDeltaMin_Q15[k+1]) .
3041 ]]></artwork>
3042 </figure>
3043 </t>
3044
3045 </section>
3046
3047 <section anchor="silk_nlsf_interpolation" title="Normalized LSF Interpolation">
3048 <t>
3049 For 20&nbsp;ms SILK frames, the first half of the frame (i.e., the first two
3050  subframes) may use normalized LSF coefficients that are interpolated between
3051  the decoded LSFs for the most recent coded frame (in the same channel) and the
3052  current frame.
3053 A Q2 interpolation factor follows the LSF coefficient indices in the bitstream,
3054  which is decoded using the PDF in <xref target="silk_nlsf_interp_pdf"/>.
3055 This happens in silk_decode_indices() (decode_indices.c).
3056 After either
3057 <list style="symbols">
3058 <t>An uncoded regular SILK frame in the side channel, or</t>
3059 <t>A decoder reset (see <xref target="decoder-reset"/>),</t>
3060 </list>
3061  the decoder still decodes this factor, but ignores its value and always uses
3062  4 instead.
3063 For 10&nbsp;ms SILK frames, this factor is not stored at all.
3064 </t>
3065
3066 <texttable anchor="silk_nlsf_interp_pdf"
3067            title="PDF for Normalized LSF Interpolation Index">
3068 <ttcol>PDF</ttcol>
3069 <c>{13, 22, 29, 11, 181}/256</c>
3070 </texttable>
3071
3072 <t>
3073 Let n2_Q15[k] be the normalized LSF coefficients decoded by the procedure in
3074  <xref target="silk_nlsfs"/>, n0_Q15[k] be the LSF coefficients
3075  decoded for the prior frame, and w_Q2 be the interpolation factor.
3076 Then the normalized LSF coefficients used for the first half of a 20&nbsp;ms
3077  frame, n1_Q15[k], are
3078 <figure align="center">
3079 <artwork align="center"><![CDATA[
3080 n1_Q15[k] = n0_Q15[k] + (w_Q2*(n2_Q15[k] - n0_Q15[k]) >> 2) .
3081 ]]></artwork>
3082 </figure>
3083 This interpolation is performed in silk_decode_parameters()
3084  (decode_parameters.c).
3085 </t>
3086 </section>
3087
3088 <section anchor="silk_nlsf2lpc"
3089  title="Converting Normalized LSFs to LPC Coefficients">
3090 <t>
3091 Any LPC filter A(z) can be split into a symmetric part P(z) and an
3092  anti-symmetric part Q(z) such that
3093 <figure align="center">
3094 <artwork align="center"><![CDATA[
3095           d_LPC
3096            __         -k   1
3097 A(z) = 1 - \  a[k] * z   = - * (P(z) + Q(z))
3098            /_              2
3099            k=1
3100 ]]></artwork>
3101 </figure>
3102 with
3103 <figure align="center">
3104 <artwork align="center"><![CDATA[
3105                -d_LPC-1      -1
3106 P(z) = A(z) + z         * A(z  )
3107
3108                -d_LPC-1      -1
3109 Q(z) = A(z) - z         * A(z  ) .
3110 ]]></artwork>
3111 </figure>
3112 The even normalized LSF coefficients correspond to a pair of conjugate roots of
3113  P(z), while the odd coefficients correspond to a pair of conjugate roots of
3114  Q(z), all of which lie on the unit circle.
3115 In addition, P(z) has a root at pi and Q(z) has a root at 0.
3116 Thus, they may be reconstructed mathematically from a set of normalized LSF
3117  coefficients, n[k], as
3118 <figure align="center">
3119 <artwork align="center"><![CDATA[
3120                  d_LPC/2-1
3121              -1     ___                        -1    -2
3122 P(z) = (1 + z  ) *  | |  (1 - 2*cos(pi*n[2*k])*z  + z  )
3123                     k=0
3124
3125                  d_LPC/2-1
3126              -1     ___                          -1    -2
3127 Q(z) = (1 - z  ) *  | |  (1 - 2*cos(pi*n[2*k+1])*z  + z  )
3128                     k=0
3129 ]]></artwork>
3130 </figure>
3131 </t>
3132 <t>
3133 However, SILK performs this reconstruction using a fixed-point approximation so
3134  that all decoders can reproduce it in a bit-exact manner to avoid prediction
3135  drift.
3136 The function silk_NLSF2A() (NLSF2A.c) implements this procedure.
3137 </t>
3138 <t>
3139 To start, it approximates cos(pi*n[k]) using a table lookup with linear
3140  interpolation.
3141 The encoder SHOULD use the inverse of this piecewise linear approximation,
3142  rather than the true inverse of the cosine function, when deriving the
3143  normalized LSF coefficients.
3144 These values are also re-ordered to improve numerical accuracy when
3145  constructing the LPC polynomials.
3146 </t>
3147
3148 <texttable anchor="silk_nlsf_orderings"
3149            title="LSF Ordering for Polynomial Evaluation">
3150 <ttcol>Coefficient</ttcol>
3151 <ttcol align="right">NB and MB</ttcol>
3152 <ttcol align="right">WB</ttcol>
3153  <c>0</c>  <c>0</c>  <c>0</c>
3154  <c>1</c>  <c>9</c> <c>15</c>
3155  <c>2</c>  <c>6</c>  <c>8</c>
3156  <c>3</c>  <c>3</c>  <c>7</c>
3157  <c>4</c>  <c>4</c>  <c>4</c>
3158  <c>5</c>  <c>5</c> <c>11</c>
3159  <c>6</c>  <c>8</c> <c>12</c>
3160  <c>7</c>  <c>1</c>  <c>3</c>
3161  <c>8</c>  <c>2</c>  <c>2</c>
3162  <c>9</c>  <c>7</c> <c>13</c>
3163 <c>10</c>      <c/> <c>10</c>
3164 <c>11</c>      <c/>  <c>5</c>
3165 <c>12</c>      <c/>  <c>6</c>
3166 <c>13</c>      <c/>  <c>9</c>
3167 <c>14</c>      <c/> <c>14</c>
3168 <c>15</c>      <c/>  <c>1</c>
3169 </texttable>
3170
3171 <t>
3172 The top 7 bits of each normalized LSF coefficient index a value in the table,
3173  and the next 8 bits interpolate between it and the next value.
3174 Let i&nbsp;=&nbsp;(n[k]&nbsp;&gt;&gt;&nbsp;8) be the integer index and
3175  f&nbsp;=&nbsp;(n[k]&nbsp;&amp;&nbsp;255) be the fractional part of a given
3176  coefficient.
3177 Then the re-ordered, approximated cosine, c_Q17[ordering[k]], is
3178 <figure align="center">
3179 <artwork align="center"><![CDATA[
3180 c_Q17[ordering[k]] = (cos_Q12[i]*256
3181                       + (cos_Q12[i+1]-cos_Q12[i])*f + 4) >> 3 ,
3182 ]]></artwork>
3183 </figure>
3184  where ordering[k] is the k'th entry of the column of
3185  <xref target="silk_nlsf_orderings"/> corresponding to the current audio
3186  bandwidth and cos_Q12[i] is the i'th entry of <xref target="silk_cos_table"/>.
3187 </t>
3188
3189 <texttable anchor="silk_cos_table"
3190            title="Q12 Cosine Table for LSF Conversion">
3191 <ttcol align="right">i</ttcol>
3192 <ttcol align="right">+0</ttcol>
3193 <ttcol align="right">+1</ttcol>
3194 <ttcol align="right">+2</ttcol>
3195 <ttcol align="right">+3</ttcol>
3196 <c>0</c>
3197  <c>4096</c> <c>4095</c> <c>4091</c> <c>4085</c>
3198 <c>4</c>
3199  <c>4076</c> <c>4065</c> <c>4052</c> <c>4036</c>
3200 <c>8</c>
3201  <c>4017</c> <c>3997</c> <c>3973</c> <c>3948</c>
3202 <c>12</c>
3203  <c>3920</c> <c>3889</c> <c>3857</c> <c>3822</c>
3204 <c>16</c>
3205  <c>3784</c> <c>3745</c> <c>3703</c> <c>3659</c>
3206 <c>20</c>
3207  <c>3613</c> <c>3564</c> <c>3513</c> <c>3461</c>
3208 <c>24</c>
3209  <c>3406</c> <c>3349</c> <c>3290</c> <c>3229</c>
3210 <c>28</c>
3211  <c>3166</c> <c>3102</c> <c>3035</c> <c>2967</c>
3212 <c>32</c>
3213  <c>2896</c> <c>2824</c> <c>2751</c> <c>2676</c>
3214 <c>36</c>
3215  <c>2599</c> <c>2520</c> <c>2440</c> <c>2359</c>
3216 <c>40</c>
3217  <c>2276</c> <c>2191</c> <c>2106</c> <c>2019</c>
3218 <c>44</c>
3219  <c>1931</c> <c>1842</c> <c>1751</c> <c>1660</c>
3220 <c>48</c>
3221  <c>1568</c> <c>1474</c> <c>1380</c> <c>1285</c>
3222 <c>52</c>
3223  <c>1189</c> <c>1093</c>  <c>995</c>  <c>897</c>
3224 <c>56</c>
3225   <c>799</c>  <c>700</c>  <c>601</c>  <c>501</c>
3226 <c>60</c>
3227   <c>401</c>  <c>301</c>  <c>201</c>  <c>101</c>
3228 <c>64</c>
3229     <c>0</c> <c>-101</c> <c>-201</c> <c>-301</c>
3230 <c>68</c>
3231  <c>-401</c> <c>-501</c> <c>-601</c> <c>-700</c>
3232 <c>72</c>
3233  <c>-799</c> <c>-897</c> <c>-995</c> <c>-1093</c>
3234 <c>76</c>
3235 <c>-1189</c><c>-1285</c><c>-1380</c><c>-1474</c>
3236 <c>80</c>
3237 <c>-1568</c><c>-1660</c><c>-1751</c><c>-1842</c>
3238 <c>84</c>
3239 <c>-1931</c><c>-2019</c><c>-2106</c><c>-2191</c>
3240 <c>88</c>
3241 <c>-2276</c><c>-2359</c><c>-2440</c><c>-2520</c>
3242 <c>92</c>
3243 <c>-2599</c><c>-2676</c><c>-2751</c><c>-2824</c>
3244 <c>96</c>
3245 <c>-2896</c><c>-2967</c><c>-3035</c><c>-3102</c>
3246 <c>100</c>
3247 <c>-3166</c><c>-3229</c><c>-3290</c><c>-3349</c>
3248 <c>104</c>
3249 <c>-3406</c><c>-3461</c><c>-3513</c><c>-3564</c>
3250 <c>108</c>
3251 <c>-3613</c><c>-3659</c><c>-3703</c><c>-3745</c>
3252 <c>112</c>
3253 <c>-3784</c><c>-3822</c><c>-3857</c><c>-3889</c>
3254 <c>116</c>
3255 <c>-3920</c><c>-3948</c><c>-3973</c><c>-3997</c>
3256 <c>120</c>
3257 <c>-4017</c><c>-4036</c><c>-4052</c><c>-4065</c>
3258 <c>124</c>
3259 <c>-4076</c><c>-4085</c><c>-4091</c><c>-4095</c>
3260 <c>128</c>
3261 <c>-4096</c>        <c/>        <c/>        <c/>
3262 </texttable>
3263
3264 <t>
3265 Given the list of cosine values, silk_NLSF2A_find_poly() (NLSF2A.c)
3266  computes the coefficients of P and Q, described here via a simple recurrence.
3267 Let p_Q16[k][j] and q_Q16[k][j] be the coefficients of the products of the
3268  first (k+1) root pairs for P and Q, with j indexing the coefficient number.
3269 Only the first (k+2) coefficients are needed, as the products are symmetric.
3270 Let p_Q16[0][0]&nbsp;=&nbsp;q_Q16[0][0]&nbsp;=&nbsp;1&lt;&lt;16,
3271  p_Q16[0][1]&nbsp;=&nbsp;-c_Q17[0], q_Q16[0][1]&nbsp;=&nbsp;-c_Q17[1], and
3272  d2&nbsp;=&nbsp;d_LPC/2.
3273 As boundary conditions, assume
3274  p_Q16[k][j]&nbsp;=&nbsp;q_Q16[k][j]&nbsp;=&nbsp;0 for all
3275  j&nbsp;&lt;&nbsp;0.
3276 Also, assume p_Q16[k][k+2]&nbsp;=&nbsp;p_Q16[k][k] and
3277  q_Q16[k][k+2]&nbsp;=&nbsp;q_Q16[k][k] (because of the symmetry).
3278 Then, for 0&nbsp;&lt;&nbsp;k&nbsp;&lt;&nbsp;d2 and 0&nbsp;&lt;=&nbsp;j&nbsp;&lt;=&nbsp;k+1,
3279 <figure align="center">
3280 <artwork align="center"><![CDATA[
3281 p_Q16[k][j] = p_Q16[k-1][j] + p_Q16[k-1][j-2]
3282               - ((c_Q17[2*k]*p_Q16[k-1][j-1] + 32768)>>16) ,
3283
3284 q_Q16[k][j] = q_Q16[k-1][j] + q_Q16[k-1][j-2]
3285               - ((c_Q17[2*k+1]*q_Q16[k-1][j-1] + 32768)>>16) .
3286 ]]></artwork>
3287 </figure>
3288 The use of Q17 values for the cosine terms in an otherwise Q16 expression
3289  implicitly scales them by a factor of 2.
3290 The multiplications in this recurrence may require up to 48 bits of precision
3291  in the result to avoid overflow.
3292 In practice, each row of the recurrence only depends on the previous row, so an
3293  implementation does not need to store all of them.
3294 </t>
3295 <t>
3296 silk_NLSF2A() uses the values from the last row of this recurrence to
3297  reconstruct a 32-bit version of the LPC filter (without the leading 1.0
3298  coefficient), a32_Q17[k], 0&nbsp;&lt;=&nbsp;k&nbsp;&lt;&nbsp;d2:
3299 <figure align="center">
3300 <artwork align="center"><![CDATA[
3301 a32_Q17[k]         = -(q_Q16[d2-1][k+1] - q_Q16[d2-1][k])
3302                      - (p_Q16[d2-1][k+1] + p_Q16[d2-1][k])) ,
3303
3304 a32_Q17[d_LPC-k-1] =  (q_Q16[d2-1][k+1] - q_Q16[d2-1][k])
3305                      - (p_Q16[d2-1][k+1] + p_Q16[d2-1][k])) .
3306 ]]></artwork>
3307 </figure>
3308 The sum and difference of two terms from each of the p_Q16 and q_Q16
3309  coefficient lists reflect the (1&nbsp;+&nbsp;z**-1) and
3310  (1&nbsp;-&nbsp;z**-1) factors of P and Q, respectively.
3311 The promotion of the expression from Q16 to Q17 implicitly scales the result
3312  by 1/2.
3313 </t>
3314 </section>
3315
3316 <section anchor="silk_lpc_range_limit"
3317  title="Limiting the Range of the LPC Coefficients">
3318 <t>
3319 The a32_Q17[] coefficients are too large to fit in a 16-bit value, which
3320  significantly increases the cost of applying this filter in fixed-point
3321  decoders.
3322 Reducing them to Q12 precision doesn't incur any significant quality loss,
3323  but still does not guarantee they will fit.
3324 silk_NLSF2A() applies up to 10 rounds of bandwidth expansion to limit
3325  the dynamic range of these coefficients.
3326 Even floating-point decoders SHOULD perform these steps, to avoid mismatch.
3327 </t>
3328 <t>
3329 For each round, the process first finds the index k such that abs(a32_Q17[k])
3330  is largest, breaking ties by choosing the lowest value of k.
3331 Then, it computes the corresponding Q12 precision value, maxabs_Q12, subject to
3332  an upper bound to avoid overflow in subsequent computations:
3333 <figure align="center">
3334 <artwork align="center"><![CDATA[
3335 maxabs_Q12 = min((maxabs_Q17 + 16) >> 5, 163838) .
3336 ]]></artwork>
3337 </figure>
3338 If this is larger than 32767, the procedure derives the chirp factor,
3339  sc_Q16[0], to use in the bandwidth expansion as
3340 <figure align="center">
3341 <artwork align="center"><![CDATA[
3342                     (maxabs_Q12 - 32767) << 14
3343 sc_Q16[0] = 65470 - -------------------------- ,
3344                     (maxabs_Q12 * (k+1)) >> 2
3345 ]]></artwork>
3346 </figure>
3347  where the division here is exact integer division.
3348 This is an approximation of the chirp factor needed to reduce the target
3349  coefficient to 32767, though it is both less than 0.999 and, for
3350  k&nbsp;&gt;&nbsp;0 when maxabs_Q12 is much greater than 32767, still slightly
3351  too large.
3352 The upper bound on maxabs_Q12, 163838, was chosen because it is equal to
3353  ((2**31&nbsp;-&nbsp;1)&nbsp;&gt;&gt;&nbsp;14)&nbsp;+&nbsp;32767, i.e., the
3354  largest value of maxabs_Q12 that would not overflow the numerator in the
3355  equation above when stored in a signed 32-bit integer.
3356 </t>
3357 <t>
3358 silk_bwexpander_32() (bwexpander_32.c) performs the bandwidth expansion (again,
3359  only when maxabs_Q12 is greater than 32767) using the following recurrence:
3360 <figure align="center">
3361 <artwork align="center"><![CDATA[
3362  a32_Q17[k] = (a32_Q17[k]*sc_Q16[k]) >> 16
3363
3364 sc_Q16[k+1] = (sc_Q16[0]*sc_Q16[k] + 32768) >> 16
3365 ]]></artwork>
3366 </figure>
3367 The first multiply may require up to 48 bits of precision in the result to
3368  avoid overflow.
3369 The second multiply must be unsigned to avoid overflow with only 32 bits of
3370  precision.
3371 The reference implementation uses a slightly more complex formulation that
3372  avoids the 32-bit overflow using signed multiplication, but is otherwise
3373  equivalent.
3374 </t>
3375 <t>
3376 After 10 rounds of bandwidth expansion are performed, they are simply saturated
3377  to 16 bits:
3378 <figure align="center">
3379 <artwork align="center"><![CDATA[
3380 a32_Q17[k] = clamp(-32768, (a32_Q17[k] + 16) >> 5, 32767) << 5 .
3381 ]]></artwork>
3382 </figure>
3383 Because this performs the actual saturation in the Q12 domain, but converts the
3384  coefficients back to the Q17 domain for the purposes of prediction gain
3385  limiting, this step must be performed after the 10th round of bandwidth
3386  expansion, regardless of whether or not the Q12 version of any coefficient
3387  still overflows a 16-bit integer.
3388 This saturation is not performed if maxabs_Q12 drops to 32767 or less prior to
3389  the 10th round.
3390 </t>
3391 </section>
3392
3393 <section anchor="silk_lpc_gain_limit"
3394  title="Limiting the Prediction Gain of the LPC Filter">
3395 <t>
3396 The prediction gain of an LPC synthesis filter is the square-root of the output
3397  energy when the filter is excited by a unit-energy impulse.
3398 Even if the Q12 coefficients would fit, the resulting filter may still have a
3399  significant gain (especially for voiced sounds), making the filter unstable.
3400 silk_NLSF2A() applies up to 18 additional rounds of bandwidth expansion to
3401  limit the prediction gain.
3402 Instead of controlling the amount of bandwidth expansion using the prediction
3403  gain itself (which may diverge to infinity for an unstable filter),
3404  silk_NLSF2A() uses silk_LPC_inverse_pred_gain_QA() (LPC_inv_pred_gain.c) to
3405  compute the reflection coefficients associated with the filter.
3406 The filter is stable if and only if the magnitude of these coefficients is
3407  sufficiently less than one.
3408 The reflection coefficients, rc[k], can be computed using a simple Levinson
3409  recurrence, initialized with the LPC coefficients
3410  a[d_LPC-1][n]&nbsp;=&nbsp;a[n], and then updated via
3411 <figure align="center">
3412 <artwork align="center"><![CDATA[
3413     rc[k] = -a[k][k] ,
3414
3415             a[k][n] - a[k][k-n-1]*rc[k]
3416 a[k-1][n] = --------------------------- .
3417                              2
3418                     1 - rc[k]
3419 ]]></artwork>
3420 </figure>
3421 </t>
3422 <t>
3423 However, silk_LPC_inverse_pred_gain_QA() approximates this using fixed-point
3424  arithmetic to guarantee reproducible results across platforms and
3425  implementations.
3426 Since small changes in the coefficients can make a stable filter unstable, it
3427  takes the real Q12 coefficients that will be used during reconstruction as
3428  input.
3429 Thus, let
3430 <figure align="center">
3431 <artwork align="center"><![CDATA[
3432 a32_Q12[n] = (a32_Q17[n] + 16) >> 5
3433 ]]></artwork>
3434 </figure>
3435  be the Q12 version of the LPC coefficients that will eventually be used.
3436 As a simple initial check, the decoder computes the DC response as
3437 <figure align="center">
3438 <artwork align="center"><![CDATA[
3439         d_PLC-1
3440           __
3441 DC_resp = \   a32_Q12[n]
3442           /_
3443           n=0
3444 ]]></artwork>
3445 </figure>
3446  and if DC_resp&nbsp;&gt;&nbsp;4096, the filter is unstable.
3447 </t>
3448 <t>
3449 Increasing the precision of these Q12 coefficients to Q24 for intermediate
3450  computations allows more accurate computation of the reflection coefficients,
3451  so the decoder initializes the recurrence via
3452 <figure align="center">
3453 <artwork align="center"><![CDATA[
3454 a32_Q24[d_LPC-1][n] = a32_Q12[n] << 12 .
3455 ]]></artwork>
3456 </figure>
3457 Then for each k from d_LPC-1 down to 0, if
3458  abs(a32_Q24[k][k])&nbsp;&gt;&nbsp;16773022, the filter is unstable and the
3459  recurrence stops.
3460 The constant 16773022 here is approximately 0.99975 in Q24.
3461 Otherwise, row k-1 of a32_Q24 is computed from row k as
3462 <figure align="center">
3463 <artwork align="center"><![CDATA[
3464       rc_Q31[k] = -a32_Q24[k][k] << 7 ,
3465
3466      div_Q30[k] = (1<<30) - (rc_Q31[k]*rc_Q31[k] >> 32) ,
3467
3468           b1[k] = ilog(div_Q30[k]) ,
3469
3470           b2[k] = b1[k] - 16 ,
3471
3472                         (1<<29) - 1
3473      inv_Qb2[k] = ----------------------- ,
3474                   div_Q30[k] >> (b2[k]+1)
3475
3476      err_Q29[k] = (1<<29)
3477                   - ((div_Q30[k]<<(15-b2[k]))*inv_Qb2[k] >> 16) ,
3478
3479     gain_Qb1[k] = ((inv_Qb2[k] << 16)
3480                    + (err_Q29[k]*inv_Qb2[k] >> 13)) ,
3481
3482 num_Q24[k-1][n] = a32_Q24[k][n]
3483                   - ((a32_Q24[k][k-n-1]*rc_Q31[k] + (1<<30)) >> 31) ,
3484
3485 a32_Q24[k-1][n] = (num_Q24[k-1][n]*gain_Qb1[k]
3486                    + (1<<(b1[k]-1))) >> b1[k] ,
3487 ]]></artwork>
3488 </figure>
3489  where 0&nbsp;&lt;=&nbsp;n&nbsp;&lt;&nbsp;k.
3490 Here, rc_Q30[k] are the reflection coefficients.
3491 div_Q30[k] is the denominator for each iteration, and gain_Qb1[k] is its
3492  multiplicative inverse (with b1[k] fractional bits, where b1[k] ranges from
3493  20 to 31).
3494 inv_Qb2[k], which ranges from 16384 to 32767, is a low-precision version of
3495  that inverse (with b2[k] fractional bits).
3496 err_Q29[k] is the residual error, ranging from -32763 to 32392, which is used
3497  to improve the accuracy.
3498 The values t_Q24[k-1][n] for each n are the numerators for the next row of
3499  coefficients in the recursion, and a32_Q24[k-1][n] is the final version of
3500  that row.
3501 Every multiply in this procedure except the one used to compute gain_Qb1[k]
3502  requires more than 32 bits of precision, but otherwise all intermediate
3503  results fit in 32 bits or less.
3504 In practice, because each row only depends on the next one, an implementation
3505  does not need to store them all.
3506 </t>
3507 <t>
3508 If abs(a32_Q24[k][k])&nbsp;&lt;=&nbsp;16773022 for
3509  0&nbsp;&lt;=&nbsp;k&nbsp;&lt;&nbsp;d_LPC, then the filter is considered stable.
3510 However, the problem of determining stability is ill-conditioned when the
3511  filter contains several reflection coefficients whose magnitude is very close
3512  to one.
3513 This fixed-point algorithm is not mathematically guaranteed to correctly
3514  classify filters as stable or unstable in this case, though it does very well
3515  in practice.
3516 </t>
3517 <t>
3518 On round i, 1&nbsp;&lt;=&nbsp;i&nbsp;&lt;=&nbsp;18, if the filter passes these
3519  stability checks, then this procedure stops, and the final LPC coefficients to
3520  use for reconstruction in <xref target="silk_lpc_synthesis"/> are
3521 <figure align="center">
3522 <artwork align="center"><![CDATA[
3523 a_Q12[k] = (a32_Q17[k] + 16) >> 5 .
3524 ]]></artwork>
3525 </figure>
3526 Otherwise, a round of bandwidth expansion is applied using the same procedure
3527  as in <xref target="silk_lpc_range_limit"/>, with
3528 <figure align="center">
3529 <artwork align="center"><![CDATA[
3530 sc_Q16[0] = 65536 - i*(i+9) .
3531 ]]></artwork>
3532 </figure>
3533 If, after the 18th round, the filter still fails these stability checks, then
3534  a_Q12[k] is set to 0 for all k.
3535 </t>
3536 </section>
3537
3538 </section>
3539
3540 <section anchor="silk_ltp_params" toc="include"
3541  title="Long-Term Prediction (LTP) Parameters">
3542 <t>
3543 After the normalized LSF indices and, for 20&nbsp;ms frames, the LSF
3544  interpolation index, voiced frames (see <xref target="silk_frame_type"/>)
3545  include additional LTP parameters.
3546 There is one primary lag index for each SILK frame, but this is refined to
3547  produce a separate lag index per subframe using a vector quantizer.
3548 Each subframe also gets its own prediction gain coefficient.
3549 </t>
3550
3551 <section anchor="silk_ltp_lags" title="Pitch Lags">
3552 <t>
3553 The primary lag index is coded either relative to the primary lag of the prior
3554  frame in the same channel, or as an absolute index.
3555 Absolute coding is used if and only if
3556 <list style="symbols">
3557 <t>
3558 This is the first SILK frame of its type (LBRR or regular) for this channel in
3559  the current Opus frame,
3560 </t>
3561 <t>
3562 The previous SILK frame of the same type (LBRR or regular) for this channel in
3563  the same Opus frame was not coded, or
3564 </t>
3565 <t>
3566 That previous SILK frame was coded, but was not voiced (see
3567  <xref target="silk_frame_type"/>).
3568 </t>
3569 </list>
3570 </t>
3571
3572 <t>
3573 With absolute coding, the primary pitch lag may range from 2&nbsp;ms
3574  (inclusive) up to 18&nbsp;ms (exclusive), corresponding to pitches from
3575  500&nbsp;Hz down to 55.6&nbsp;Hz, respectively.
3576 It is comprised of a high part and a low part, where the decoder reads the high
3577  part using the 32-entry codebook in <xref target="silk_abs_pitch_high_pdf"/>
3578  and the low part using the codebook corresponding to the current audio
3579  bandwidth from <xref target="silk_abs_pitch_low_pdf"/>.
3580 The final primary pitch lag is then
3581 <figure align="center">
3582 <artwork align="center"><![CDATA[
3583 lag = lag_high*lag_scale + lag_low + lag_min
3584 ]]></artwork>
3585 </figure>
3586  where lag_high is the high part, lag_low is the low part, and lag_scale
3587  and lag_min are the values from the "Scale" and "Minimum Lag" columns of
3588  <xref target="silk_abs_pitch_low_pdf"/>, respectively.
3589 </t>
3590
3591 <texttable anchor="silk_abs_pitch_high_pdf"
3592  title="PDF for High Part of Primary Pitch Lag">
3593 <ttcol align="left">PDF</ttcol>
3594 <c>{3,   3,   6,  11,  21,  30,  32,  19,
3595    11,  10,  12,  13,  13,  12,  11,   9,
3596     8,   7,   6,   4,   2,   2,   2,   1,
3597     1,   1,   1,   1,   1,   1,   1,   1}/256</c>
3598 </texttable>
3599
3600 <texttable anchor="silk_abs_pitch_low_pdf"
3601  title="PDF for Low Part of Primary Pitch Lag">
3602 <ttcol>Audio Bandwidth</ttcol>
3603 <ttcol>PDF</ttcol>
3604 <ttcol>Scale</ttcol>
3605 <ttcol>Minimum Lag</ttcol>
3606 <ttcol>Maximum Lag</ttcol>
3607 <c>NB</c> <c>{64, 64, 64, 64}/256</c>                 <c>4</c> <c>16</c> <c>144</c>
3608 <c>MB</c> <c>{43, 42, 43, 43, 42, 43}/256</c>         <c>6</c> <c>24</c> <c>216</c>
3609 <c>WB</c> <c>{32, 32, 32, 32, 32, 32, 32, 32}/256</c> <c>8</c> <c>32</c> <c>288</c>
3610 </texttable>
3611
3612 <t>
3613 All frames that do not use absolute coding for the primary lag index use
3614  relative coding instead.
3615 The decoder reads a single delta value using the 21-entry PDF in
3616  <xref target="silk_rel_pitch_pdf"/>.
3617 If the resulting value is zero, it falls back to the absolute coding procedure
3618  from the prior paragraph.
3619 Otherwise, the final primary pitch lag is then
3620 <figure align="center">
3621 <artwork align="center"><![CDATA[
3622 lag = previous_lag + (delta_lag_index - 9)
3623 ]]></artwork>
3624 </figure>
3625  where previous_lag is the primary pitch lag from the most recent frame in the
3626  same channel and delta_lag_index is the value just decoded.
3627 This allows a per-frame change in the pitch lag of -8 to +11 samples.
3628 The decoder does no clamping at this point, so this value can fall outside the
3629  range of 2&nbsp;ms to 18&nbsp;ms, and the decoder must use this unclamped
3630  value when using relative coding in the next SILK frame (if any).
3631 However, because an Opus frame can use relative coding for at most two
3632  consecutive SILK frames, integer overflow should not be an issue.
3633 </t>
3634
3635 <texttable anchor="silk_rel_pitch_pdf"
3636  title="PDF for Primary Pitch Lag Change">
3637 <ttcol align="left">PDF</ttcol>
3638 <c>{46,  2,  2,  3,  4,  6, 10, 15,
3639     26, 38, 30, 22, 15, 10,  7,  6,
3640      4,  4,  2,  2,  2}/256</c>
3641 </texttable>
3642
3643 <t>
3644 After the primary pitch lag, a "pitch contour", stored as a single entry from
3645  one of four small VQ codebooks, gives lag offsets for each subframe in the
3646  current SILK frame.
3647 The codebook index is decoded using one of the PDFs in
3648  <xref target="silk_pitch_contour_pdfs"/> depending on the current frame size
3649  and audio bandwidth.
3650 Tables&nbsp;<xref format="counter" target="silk_pitch_contour_cb_nb10ms"/>
3651  through&nbsp;<xref format="counter" target="silk_pitch_contour_cb_mbwb20ms"/>
3652  give the corresponding offsets to apply to the primary pitch lag for each
3653  subframe given the decoded codebook index.
3654 </t>
3655
3656 <texttable anchor="silk_pitch_contour_pdfs"
3657  title="PDFs for Subframe Pitch Contour">
3658 <ttcol>Audio Bandwidth</ttcol>
3659 <ttcol>SILK Frame Size</ttcol>
3660 <ttcol align="right">Codebook Size</ttcol>
3661 <ttcol>PDF</ttcol>
3662 <c>NB</c>       <c>10&nbsp;ms</c>  <c>3</c>
3663 <c>{143, 50, 63}/256</c>
3664 <c>NB</c>       <c>20&nbsp;ms</c> <c>11</c>
3665 <c>{68, 12, 21, 17, 19, 22, 30, 24,
3666     17, 16, 10}/256</c>
3667 <c>MB or WB</c> <c>10&nbsp;ms</c> <c>12</c>
3668 <c>{91, 46, 39, 19, 14, 12,  8,  7,
3669      6,  5,  5,  4}/256</c>
3670 <c>MB or WB</c> <c>20&nbsp;ms</c> <c>34</c>
3671 <c>{33, 22, 18, 16, 15, 14, 14, 13,
3672     13, 10,  9,  9,  8,  6,  6,  6,
3673      5,  4,  4,  4,  3,  3,  3,  2,
3674      2,  2,  2,  2,  2,  2,  1,  1,
3675      1,  1}/256</c>
3676 </texttable>
3677
3678 <texttable anchor="silk_pitch_contour_cb_nb10ms"
3679  title="Codebook Vectors for Subframe Pitch Contour: NB, 10&nbsp;ms Frames">
3680 <ttcol>Index</ttcol>
3681 <ttcol align="right">Subframe Offsets</ttcol>
3682 <c>0</c> <c><spanx style="vbare">&nbsp;0&nbsp;&nbsp;0</spanx></c>
3683 <c>1</c> <c><spanx style="vbare">&nbsp;1&nbsp;&nbsp;0</spanx></c>
3684 <c>2</c> <c><spanx style="vbare">&nbsp;0&nbsp;&nbsp;1</spanx></c>
3685 </texttable>
3686
3687 <texttable anchor="silk_pitch_contour_cb_nb20ms"
3688  title="Codebook Vectors for Subframe Pitch Contour: NB, 20&nbsp;ms Frames">
3689 <ttcol>Index</ttcol>
3690 <ttcol align="right">Subframe Offsets</ttcol>
3691  <c>0</c> <c><spanx style="vbare">&nbsp;0&nbsp;&nbsp;0&nbsp;&nbsp;0&nbsp;&nbsp;0</spanx></c>
3692  <c>1</c> <c><spanx style="vbare">&nbsp;2&nbsp;&nbsp;1&nbsp;&nbsp;0&nbsp;-1</spanx></c>
3693  <c>2</c> <c><spanx style="vbare">-1&nbsp;&nbsp;0&nbsp;&nbsp;1&nbsp;&nbsp;2</spanx></c>
3694  <c>3</c> <c><spanx style="vbare">-1&nbsp;&nbsp;0&nbsp;&nbsp;0&nbsp;&nbsp;1</spanx></c>
3695  <c>4</c> <c><spanx style="vbare">-1&nbsp;&nbsp;0&nbsp;&nbsp;0&nbsp;&nbsp;0</spanx></c>
3696  <c>5</c> <c><spanx style="vbare">&nbsp;0&nbsp;&nbsp;0&nbsp;&nbsp;0&nbsp;&nbsp;1</spanx></c>
3697  <c>6</c> <c><spanx style="vbare">&nbsp;0&nbsp;&nbsp;0&nbsp;&nbsp;1&nbsp;&nbsp;1</spanx></c>
3698  <c>7</c> <c><spanx style="vbare">&nbsp;1&nbsp;&nbsp;1&nbsp;&nbsp;0&nbsp;&nbsp;0</spanx></c>
3699  <c>8</c> <c><spanx style="vbare">&nbsp;1&nbsp;&nbsp;0&nbsp;&nbsp;0&nbsp;&nbsp;0</spanx></c>
3700  <c>9</c> <c><spanx style="vbare">&nbsp;0&nbsp;&nbsp;0&nbsp;&nbsp;0&nbsp;-1</spanx></c>
3701 <c>10</c> <c><spanx style="vbare">&nbsp;1&nbsp;&nbsp;0&nbsp;&nbsp;0&nbsp;-1</spanx></c>
3702 </texttable>
3703
3704 <texttable anchor="silk_pitch_contour_cb_mbwb10ms"
3705  title="Codebook Vectors for Subframe Pitch Contour: MB or WB, 10&nbsp;ms Frames">
3706 <ttcol>Index</ttcol>
3707 <ttcol align="right">Subframe Offsets</ttcol>
3708  <c>0</c> <c><spanx style="vbare">&nbsp;0&nbsp;&nbsp;0</spanx></c>
3709  <c>1</c> <c><spanx style="vbare">&nbsp;0&nbsp;&nbsp;1</spanx></c>
3710  <c>2</c> <c><spanx style="vbare">&nbsp;1&nbsp;&nbsp;0</spanx></c>
3711  <c>3</c> <c><spanx style="vbare">-1&nbsp;&nbsp;1</spanx></c>
3712  <c>4</c> <c><spanx style="vbare">&nbsp;1&nbsp;-1</spanx></c>
3713  <c>5</c> <c><spanx style="vbare">-1&nbsp;&nbsp;2</spanx></c>
3714  <c>6</c> <c><spanx style="vbare">&nbsp;2&nbsp;-1</spanx></c>
3715  <c>7</c> <c><spanx style="vbare">-2&nbsp;&nbsp;2</spanx></c>
3716  <c>8</c> <c><spanx style="vbare">&nbsp;2&nbsp;-2</spanx></c>
3717  <c>9</c> <c><spanx style="vbare">-2&nbsp;&nbsp;3</spanx></c>
3718 <c>10</c> <c><spanx style="vbare">&nbsp;3&nbsp;-2</spanx></c>
3719 <c>11</c> <c><spanx style="vbare">-3&nbsp;&nbsp;3</spanx></c>
3720 </texttable>
3721
3722 <texttable anchor="silk_pitch_contour_cb_mbwb20ms"
3723  title="Codebook Vectors for Subframe Pitch Contour: MB or WB, 20&nbsp;ms Frames">
3724 <ttcol>Index</ttcol>
3725 <ttcol align="right">Subframe Offsets</ttcol>
3726  <c>0</c> <c><spanx style="vbare">&nbsp;0&nbsp;&nbsp;0&nbsp;&nbsp;0&nbsp;&nbsp;0</spanx></c>
3727  <c>1</c> <c><spanx style="vbare">&nbsp;0&nbsp;&nbsp;0&nbsp;&nbsp;1&nbsp;&nbsp;1</spanx></c>
3728  <c>2</c> <c><spanx style="vbare">&nbsp;1&nbsp;&nbsp;1&nbsp;&nbsp;0&nbsp;&nbsp;0</spanx></c>
3729  <c>3</c> <c><spanx style="vbare">-1&nbsp;&nbsp;0&nbsp;&nbsp;0&nbsp;&nbsp;0</spanx></c>
3730  <c>4</c> <c><spanx style="vbare">&nbsp;0&nbsp;&nbsp;0&nbsp;&nbsp;0&nbsp;&nbsp;1</spanx></c>
3731  <c>5</c> <c><spanx style="vbare">&nbsp;1&nbsp;&nbsp;0&nbsp;&nbsp;0&nbsp;&nbsp;0</spanx></c>
3732  <c>6</c> <c><spanx style="vbare">-1&nbsp;&nbsp;0&nbsp;&nbsp;0&nbsp;&nbsp;1</spanx></c>
3733  <c>7</c> <c><spanx style="vbare">&nbsp;0&nbsp;&nbsp;0&nbsp;&nbsp;0&nbsp;-1</spanx></c>
3734  <c>8</c> <c><spanx style="vbare">-1&nbsp;&nbsp;0&nbsp;&nbsp;1&nbsp;&nbsp;2</spanx></c>
3735  <c>9</c> <c><spanx style="vbare">&nbsp;1&nbsp;&nbsp;0&nbsp;&nbsp;0&nbsp;-1</spanx></c>
3736 <c>10</c> <c><spanx style="vbare">-2&nbsp;-1&nbsp;&nbsp;1&nbsp;&nbsp;2</spanx></c>
3737 <c>11</c> <c><spanx style="vbare">&nbsp;2&nbsp;&nbsp;1&nbsp;&nbsp;0&nbsp;-1</spanx></c>
3738 <c>12</c> <c><spanx style="vbare">-2&nbsp;&nbsp;0&nbsp;&nbsp;0&nbsp;&nbsp;2</spanx></c>
3739 <c>13</c> <c><spanx style="vbare">-2&nbsp;&nbsp;0&nbsp;&nbsp;1&nbsp;&nbsp;3</spanx></c>
3740 <c>14</c> <c><spanx style="vbare">&nbsp;2&nbsp;&nbsp;1&nbsp;-1&nbsp;-2</spanx></c>
3741 <c>15</c> <c><spanx style="vbare">-3&nbsp;-1&nbsp;&nbsp;1&nbsp;&nbsp;3</spanx></c>
3742 <c>16</c> <c><spanx style="vbare">&nbsp;2&nbsp;&nbsp;0&nbsp;&nbsp;0&nbsp;-2</spanx></c>
3743 <c>17</c> <c><spanx style="vbare">&nbsp;3&nbsp;&nbsp;1&nbsp;&nbsp;0&nbsp;-2</spanx></c>
3744 <c>18</c> <c><spanx style="vbare">-3&nbsp;-1&nbsp;&nbsp;2&nbsp;&nbsp;4</spanx></c>
3745 <c>19</c> <c><spanx style="vbare">-4&nbsp;-1&nbsp;&nbsp;1&nbsp;&nbsp;4</spanx></c>
3746 <c>20</c> <c><spanx style="vbare">&nbsp;3&nbsp;&nbsp;1&nbsp;-1&nbsp;-3</spanx></c>
3747 <c>21</c> <c><spanx style="vbare">-4&nbsp;-1&nbsp;&nbsp;2&nbsp;&nbsp;5</spanx></c>
3748 <c>22</c> <c><spanx style="vbare">&nbsp;4&nbsp;&nbsp;2&nbsp;-1&nbsp;-3</spanx></c>
3749 <c>23</c> <c><spanx style="vbare">&nbsp;4&nbsp;&nbsp;1&nbsp;-1&nbsp;-4</spanx></c>
3750 <c>24</c> <c><spanx style="vbare">-5&nbsp;-1&nbsp;&nbsp;2&nbsp;&nbsp;6</spanx></c>
3751 <c>25</c> <c><spanx style="vbare">&nbsp;5&nbsp;&nbsp;2&nbsp;-1&nbsp;-4</spanx></c>
3752 <c>26</c> <c><spanx style="vbare">-6&nbsp;-2&nbsp;&nbsp;2&nbsp;&nbsp;6</spanx></c>
3753 <c>27</c> <c><spanx style="vbare">-5&nbsp;-2&nbsp;&nbsp;2&nbsp;&nbsp;5</spanx></c>
3754 <c>28</c> <c><spanx style="vbare">&nbsp;6&nbsp;&nbsp;2&nbsp;-1&nbsp;-5</spanx></c>
3755 <c>29</c> <c><spanx style="vbare">-7&nbsp;-2&nbsp;&nbsp;3&nbsp;&nbsp;8</spanx></c>
3756 <c>30</c> <c><spanx style="vbare">&nbsp;6&nbsp;&nbsp;2&nbsp;-2&nbsp;-6</spanx></c>
3757 <c>31</c> <c><spanx style="vbare">&nbsp;5&nbsp;&nbsp;2&nbsp;-2&nbsp;-5</spanx></c>
3758 <c>32</c> <c><spanx style="vbare">&nbsp;8&nbsp;&nbsp;3&nbsp;-2&nbsp;-7</spanx></c>
3759 <c>33</c> <c><spanx style="vbare">-9&nbsp;-3&nbsp;&nbsp;3&nbsp;&nbsp;9</spanx></c>
3760 </texttable>
3761
3762 <t>
3763 The final pitch lag for each subframe is assembled in silk_decode_pitch()
3764  (decode_pitch.c).
3765 Let lag be the primary pitch lag for the current SILK frame, contour_index be
3766  index of the VQ codebook, and lag_cb[contour_index][k] be the corresponding
3767  entry of the codebook from the appropriate table given above for the k'th
3768  subframe.
3769 Then the final pitch lag for that subframe is
3770 <figure align="center">
3771 <artwork align="center"><![CDATA[
3772 pitch_lags[k] = clamp(lag_min, lag + lag_cb[contour_index][k],
3773                       lag_max)
3774 ]]></artwork>
3775 </figure>
3776  where lag_min and lag_max are the values from the "Minimum Lag" and
3777  "Maximum Lag" columns of <xref target="silk_abs_pitch_low_pdf"/>,
3778  respectively.
3779 </t>
3780
3781 </section>
3782
3783 <section anchor="silk_ltp_filter" title="LTP Filter Coefficients">
3784 <t>
3785 SILK uses a separate 5-tap pitch filter for each subframe, selected from one
3786  of three codebooks.
3787 The three codebooks each represent different rate-distortion trade-offs, with
3788  average rates of 1.61&nbsp;bits/subframe, 3.68&nbsp;bits/subframe, and
3789  4.85&nbsp;bits/subframe, respectively.
3790 </t>
3791
3792 <t>
3793 The importance of the filter coefficients generally depends on two factors: the
3794  periodicity of the signal and relative energy between the current subframe and
3795  the signal from one period earlier.
3796 Greater periodicity and decaying energy both lead to more important filter
3797  coefficients, and thus should be coded with lower distortion and higher rate.
3798 These properties are relatively stable over the duration of a single SILK
3799  frame, hence all of the subframes in a SILK frame choose their filter from the
3800  same codebook.
3801 This is signaled with an explicitly-coded "periodicity index".
3802 This immediately follows the subframe pitch lags, and is coded using the
3803  3-entry PDF from <xref target="silk_perindex_pdf"/>.
3804 </t>
3805
3806 <texttable anchor="silk_perindex_pdf" title="Periodicity Index PDF">
3807 <ttcol>PDF</ttcol>
3808 <c>{77, 80, 99}/256</c>
3809 </texttable>
3810
3811 <t>
3812 The indices of the filters for each subframe follow.
3813 They are all coded using the PDF from <xref target="silk_ltp_filter_pdfs"/>
3814  corresponding to the periodicity index.
3815 Tables&nbsp;<xref format="counter" target="silk_ltp_filter_coeffs0"/>
3816  through&nbsp;<xref format="counter" target="silk_ltp_filter_coeffs2"/>
3817  contain the corresponding filter taps as signed Q7 integers.
3818 </t>
3819
3820 <texttable anchor="silk_ltp_filter_pdfs" title="LTP Filter PDFs">
3821 <ttcol>Periodicity Index</ttcol>
3822 <ttcol align="right">Codebook Size</ttcol>
3823 <ttcol>PDF</ttcol>
3824 <c>0</c>  <c>8</c> <c>{185, 15, 13, 13, 9, 9, 6, 6}/256</c>
3825 <c>1</c> <c>16</c> <c>{57, 34, 21, 20, 15, 13, 12, 13,
3826                        10, 10,  9, 10,  9,  8,  7,  8}/256</c>
3827 <c>2</c> <c>32</c> <c>{15, 16, 14, 12, 12, 12, 11, 11,
3828                        11, 10,  9,  9,  9,  9,  8,  8,
3829                         8,  8,  7,  7,  6,  6,  5,  4,
3830                         5,  4,  4,  4,  3,  4,  3,  2}/256</c>
3831 </texttable>
3832
3833 <texttable anchor="silk_ltp_filter_coeffs0"
3834  title="Codebook Vectors for LTP Filter, Periodicity Index 0">
3835 <ttcol>Index</ttcol>
3836 <ttcol align="right">Filter Taps (Q7)</ttcol>
3837  <c>0</c>
3838 <c><spanx style="vbare">&nbsp;&nbsp;4&nbsp;&nbsp;&nbsp;6&nbsp;&nbsp;24&nbsp;&nbsp;&nbsp;7&nbsp;&nbsp;&nbsp;5</spanx></c>
3839  <c>1</c>
3840 <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>
3841  <c>2</c>
3842 <c><spanx style="vbare">&nbsp;12&nbsp;&nbsp;28&nbsp;&nbsp;41&nbsp;&nbsp;13&nbsp;&nbsp;-4</spanx></c>
3843  <c>3</c>
3844 <c><spanx style="vbare">&nbsp;-9&nbsp;&nbsp;15&nbsp;&nbsp;42&nbsp;&nbsp;25&nbsp;&nbsp;14</spanx></c>
3845  <c>4</c>
3846 <c><spanx style="vbare">&nbsp;&nbsp;1&nbsp;&nbsp;-2&nbsp;&nbsp;62&nbsp;&nbsp;41&nbsp;&nbsp;-9</spanx></c>
3847  <c>5</c>
3848 <c><spanx style="vbare">-10&nbsp;&nbsp;37&nbsp;&nbsp;65&nbsp;&nbsp;-4&nbsp;&nbsp;&nbsp;3</spanx></c>
3849  <c>6</c>
3850 <c><spanx style="vbare">&nbsp;-6&nbsp;&nbsp;&nbsp;4&nbsp;&nbsp;66&nbsp;&nbsp;&nbsp;7&nbsp;&nbsp;-8</spanx></c>
3851  <c>7</c>
3852 <c><spanx style="vbare">&nbsp;16&nbsp;&nbsp;14&nbsp;&nbsp;38&nbsp;&nbsp;-3&nbsp;&nbsp;33</spanx></c>
3853 </texttable>
3854
3855 <texttable anchor="silk_ltp_filter_coeffs1"
3856  title="Codebook Vectors for LTP Filter, Periodicity Index 1">
3857 <ttcol>Index</ttcol>
3858 <ttcol align="right">Filter Taps (Q7)</ttcol>
3859
3860  <c>0</c>
3861 <c><spanx style="vbare">&nbsp;13&nbsp;&nbsp;22&nbsp;&nbsp;39&nbsp;&nbsp;23&nbsp;&nbsp;12</spanx></c>
3862  <c>1</c>
3863 <c><spanx style="vbare">&nbsp;-1&nbsp;&nbsp;36&nbsp;&nbsp;64&nbsp;&nbsp;27&nbsp;&nbsp;-6</spanx></c>
3864  <c>2</c>
3865 <c><spanx style="vbare">&nbsp;-7&nbsp;&nbsp;10&nbsp;&nbsp;55&nbsp;&nbsp;43&nbsp;&nbsp;17</spanx></c>
3866  <c>3</c>
3867 <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>
3868  <c>4</c>
3869 <c><spanx style="vbare">&nbsp;&nbsp;6&nbsp;-11&nbsp;&nbsp;74&nbsp;&nbsp;53&nbsp;&nbsp;-9</spanx></c>
3870  <c>5</c>
3871 <c><spanx style="vbare">-12&nbsp;&nbsp;55&nbsp;&nbsp;76&nbsp;-12&nbsp;&nbsp;&nbsp;8</spanx></c>
3872  <c>6</c>
3873 <c><spanx style="vbare">&nbsp;-3&nbsp;&nbsp;&nbsp;3&nbsp;&nbsp;93&nbsp;&nbsp;27&nbsp;&nbsp;-4</spanx></c>
3874  <c>7</c>
3875 <c><spanx style="vbare">&nbsp;26&nbsp;&nbsp;39&nbsp;&nbsp;59&nbsp;&nbsp;&nbsp;3&nbsp;&nbsp;-8</spanx></c>
3876  <c>8</c>
3877 <c><spanx style="vbare">&nbsp;&nbsp;2&nbsp;&nbsp;&nbsp;0&nbsp;&nbsp;77&nbsp;&nbsp;11&nbsp;&nbsp;&nbsp;9</spanx></c>
3878  <c>9</c>
3879 <c><spanx style="vbare">&nbsp;-8&nbsp;&nbsp;22&nbsp;&nbsp;44&nbsp;&nbsp;-6&nbsp;&nbsp;&nbsp;7</spanx></c>
3880 <c>10</c>
3881 <c><spanx style="vbare">&nbsp;40&nbsp;&nbsp;&nbsp;9&nbsp;&nbsp;26&nbsp;&nbsp;&nbsp;3&nbsp;&nbsp;&nbsp;9</spanx></c>
3882 <c>11</c>
3883 <c><spanx style="vbare">&nbsp;-7&nbsp;&nbsp;20&nbsp;101&nbsp;&nbsp;-7&nbsp;&nbsp;&nbsp;4</spanx></c>
3884 <c>12</c>
3885 <c><spanx style="vbare">&nbsp;&nbsp;3&nbsp;&nbsp;-8&nbsp;&nbsp;42&nbsp;&nbsp;26&nbsp;&nbsp;&nbsp;0</spanx></c>
3886 <c>13</c>
3887 <c><spanx style="vbare">-15&nbsp;&nbsp;33&nbsp;&nbsp;68&nbsp;&nbsp;&nbsp;2&nbsp;&nbsp;23</spanx></c>
3888 <c>14</c>
3889 <c><spanx style="vbare">&nbsp;-2&nbsp;&nbsp;55&nbsp;&nbsp;46&nbsp;&nbsp;-2&nbsp;&nbsp;15</spanx></c>
3890 <c>15</c>
3891 <c><spanx style="vbare">&nbsp;&nbsp;3&nbsp;&nbsp;-1&nbsp;&nbsp;21&nbsp;&nbsp;16&nbsp;&nbsp;41</spanx></c>
3892 </texttable>
3893
3894 <texttable anchor="silk_ltp_filter_coeffs2"
3895  title="Codebook Vectors for LTP Filter, Periodicity Index 2">
3896 <ttcol>Index</ttcol>
3897 <ttcol align="right">Filter Taps (Q7)</ttcol>
3898  <c>0</c>
3899 <c><spanx style="vbare">&nbsp;-6&nbsp;&nbsp;27&nbsp;&nbsp;61&nbsp;&nbsp;39&nbsp;&nbsp;&nbsp;5</spanx></c>
3900  <c>1</c>
3901 <c><spanx style="vbare">-11&nbsp;&nbsp;42&nbsp;&nbsp;88&nbsp;&nbsp;&nbsp;4&nbsp;&nbsp;&nbsp;1</spanx></c>
3902  <c>2</c>
3903 <c><spanx style="vbare">&nbsp;-2&nbsp;&nbsp;60&nbsp;&nbsp;65&nbsp;&nbsp;&nbsp;6&nbsp;&nbsp;-4</spanx></c>
3904  <c>3</c>
3905 <c><spanx style="vbare">&nbsp;-1&nbsp;&nbsp;-5&nbsp;&nbsp;73&nbsp;&nbsp;56&nbsp;&nbsp;&nbsp;1</spanx></c>
3906  <c>4</c>
3907 <c><spanx style="vbare">&nbsp;-9&nbsp;&nbsp;19&nbsp;&nbsp;94&nbsp;&nbsp;29&nbsp;&nbsp;-9</spanx></c>
3908  <c>5</c>
3909 <c><spanx style="vbare">&nbsp;&nbsp;0&nbsp;&nbsp;12&nbsp;&nbsp;99&nbsp;&nbsp;&nbsp;6&nbsp;&nbsp;&nbsp;4</spanx></c>
3910  <c>6</c>
3911 <c><spanx style="vbare">&nbsp;&nbsp;8&nbsp;-19&nbsp;102&nbsp;&nbsp;46&nbsp;-13</spanx></c>
3912  <c>7</c>
3913 <c><spanx style="vbare">&nbsp;&nbsp;3&nbsp;&nbsp;&nbsp;2&nbsp;&nbsp;13&nbsp;&nbsp;&nbsp;3&nbsp;&nbsp;&nbsp;2</spanx></c>
3914  <c>8</c>
3915 <c><spanx style="vbare">&nbsp;&nbsp;9&nbsp;-21&nbsp;&nbsp;84&nbsp;&nbsp;72&nbsp;-18</spanx></c>
3916  <c>9</c>
3917 <c><spanx style="vbare">-11&nbsp;&nbsp;46&nbsp;104&nbsp;-22&nbsp;&nbsp;&nbsp;8</spanx></c>
3918 <c>10</c>
3919 <c><spanx style="vbare">&nbsp;18&nbsp;&nbsp;38&nbsp;&nbsp;48&nbsp;&nbsp;23&nbsp;&nbsp;&nbsp;0</spanx></c>
3920 <c>11</c>
3921 <c><spanx style="vbare">-16&nbsp;&nbsp;70&nbsp;&nbsp;83&nbsp;-21&nbsp;&nbsp;11</spanx></c>
3922 <c>12</c>
3923 <c><spanx style="vbare">&nbsp;&nbsp;5&nbsp;-11&nbsp;117&nbsp;&nbsp;22&nbsp;&nbsp;-8</spanx></c>
3924 <c>13</c>
3925 <c><spanx style="vbare">&nbsp;-6&nbsp;&nbsp;23&nbsp;117&nbsp;-12&nbsp;&nbsp;&nbsp;3</spanx></c>
3926 <c>14</c>
3927 <c><spanx style="vbare">&nbsp;&nbsp;3&nbsp;&nbsp;-8&nbsp;&nbsp;95&nbsp;&nbsp;28&nbsp;&nbsp;&nbsp;4</spanx></c>
3928 <c>15</c>
3929 <c><spanx style="vbare">-10&nbsp;&nbsp;15&nbsp;&nbsp;77&nbsp;&nbsp;60&nbsp;-15</spanx></c>
3930 <c>16</c>
3931 <c><spanx style="vbare">&nbsp;-1&nbsp;&nbsp;&nbsp;4&nbsp;124&nbsp;&nbsp;&nbsp;2&nbsp;&nbsp;-4</spanx></c>
3932 <c>17</c>
3933 <c><spanx style="vbare">&nbsp;&nbsp;3&nbsp;&nbsp;38&nbsp;&nbsp;84&nbsp;&nbsp;24&nbsp;-25</spanx></c>
3934 <c>18</c>
3935 <c><spanx style="vbare">&nbsp;&nbsp;2&nbsp;&nbsp;13&nbsp;&nbsp;42&nbsp;&nbsp;13&nbsp;&nbsp;31</spanx></c>
3936 <c>19</c>
3937 <c><spanx style="vbare">&nbsp;21&nbsp;&nbsp;-4&nbsp;&nbsp;56&nbsp;&nbsp;46&nbsp;&nbsp;-1</spanx></c>
3938 <c>20</c>
3939 <c><spanx style="vbare">&nbsp;-1&nbsp;&nbsp;35&nbsp;&nbsp;79&nbsp;-13&nbsp;&nbsp;19</spanx></c>
3940 <c>21</c>
3941 <c><spanx style="vbare">&nbsp;-7&nbsp;&nbsp;65&nbsp;&nbsp;88&nbsp;&nbsp;-9&nbsp;-14</spanx></c>
3942 <c>22</c>
3943 <c><spanx style="vbare">&nbsp;20&nbsp;&nbsp;&nbsp;4&nbsp;&nbsp;81&nbsp;&nbsp;49&nbsp;-29</spanx></c>
3944 <c>23</c>
3945 <c><spanx style="vbare">&nbsp;20&nbsp;&nbsp;&nbsp;0&nbsp;&nbsp;75&nbsp;&nbsp;&nbsp;3&nbsp;-17</spanx></c>
3946 <c>24</c>
3947 <c><spanx style="vbare">&nbsp;&nbsp;5&nbsp;&nbsp;-9&nbsp;&nbsp;44&nbsp;&nbsp;92&nbsp;&nbsp;-8</spanx></c>
3948 <c>25</c>
3949 <c><spanx style="vbare">&nbsp;&nbsp;1&nbsp;&nbsp;-3&nbsp;&nbsp;22&nbsp;&nbsp;69&nbsp;&nbsp;31</spanx></c>
3950 <c>26</c>
3951 <c><spanx style="vbare">&nbsp;-6&nbsp;&nbsp;95&nbsp;&nbsp;41&nbsp;-12&nbsp;&nbsp;&nbsp;5</spanx></c>
3952 <c>27</c>
3953 <c><spanx style="vbare">&nbsp;39&nbsp;&nbsp;67&nbsp;&nbsp;16&nbsp;&nbsp;-4&nbsp;&nbsp;&nbsp;1</spanx></c>
3954 <c>28</c>
3955 <c><spanx style="vbare">&nbsp;&nbsp;0&nbsp;&nbsp;-6&nbsp;120&nbsp;&nbsp;55&nbsp;-36</spanx></c>
3956 <c>29</c>
3957 <c><spanx style="vbare">-13&nbsp;&nbsp;44&nbsp;122&nbsp;&nbsp;&nbsp;4&nbsp;-24</spanx></c>
3958 <c>30</c>
3959 <c><spanx style="vbare">&nbsp;81&nbsp;&nbsp;&nbsp;5&nbsp;&nbsp;11&nbsp;&nbsp;&nbsp;3&nbsp;&nbsp;&nbsp;7</spanx></c>
3960 <c>31</c>
3961 <c><spanx style="vbare">&nbsp;&nbsp;2&nbsp;&nbsp;&nbsp;0&nbsp;&nbsp;&nbsp;9&nbsp;&nbsp;10&nbsp;&nbsp;88</spanx></c>
3962 </texttable>
3963
3964 </section>
3965
3966 <section anchor="silk_ltp_scaling" title="LTP Scaling Parameter">
3967 <t>
3968 An LTP scaling parameter appears after the LTP filter coefficients if and only
3969  if
3970 <list style="symbols">
3971 <t>This is a voiced frame (see <xref target="silk_frame_type"/>), and</t>
3972 <t>Either
3973 <list style="symbols">
3974 <t>
3975 This SILK frame corresponds to the first time interval of the
3976  current Opus frame for its type (LBRR or regular), or
3977 </t>
3978 <t>
3979 This is an LBRR frame where the LBRR flags (see
3980  <xref target="silk_lbrr_flags"/>) indicate the previous LBRR frame in the same
3981  channel is not coded.
3982 </t>
3983 </list>
3984 </t>
3985 </list>
3986 This allows the encoder to trade off the prediction gain between
3987  packets against the recovery time after packet loss.
3988 Unlike absolute-coding for pitch lags, regular SILK frames that are not at the
3989  start of an Opus frame (i.e., that do not correspond to the first 20&nbsp;ms
3990  time interval in Opus frames of 40&nbsp;or 60&nbsp;ms) do not include this
3991  field, even if the prior frame was not voiced, or (in the case of the side
3992  channel) not even coded.
3993 After an uncoded frame in the side channel, the LTP buffer (see
3994  <xref target="silk_ltp_synthesis"/>) is cleared to zero, and is thus in a
3995  known state.
3996 In contrast, LBRR frames do include this field when the prior frame was not
3997  coded, since the LTP buffer contains the output of the PLC, which is
3998  non-normative.
3999 </t>
4000 <t>
4001 If present, the decoder reads a value using the 3-entry PDF in
4002  <xref target="silk_ltp_scaling_pdf"/>.
4003 The three possible values represent Q14 scale factors of 15565, 12288, and
4004  8192, respectively (corresponding to approximately 0.95, 0.75, and 0.5).
4005 Frames that do not code the scaling parameter use the default factor of 15565
4006  (approximately 0.95).
4007 </t>
4008
4009 <texttable anchor="silk_ltp_scaling_pdf"
4010  title="PDF for LTP Scaling Parameter">
4011 <ttcol align="left">PDF</ttcol>
4012 <c>{128, 64, 64}/256</c>
4013 </texttable>
4014
4015 </section>
4016
4017 </section>
4018
4019 <section anchor="silk_seed" toc="include"
4020  title="Linear Congruential Generator (LCG) Seed">
4021 <t>
4022 As described in <xref target="silk_excitation_reconstruction"/>, SILK uses a
4023  linear congruential generator (LCG) to inject pseudorandom noise into the
4024  quantized excitation.
4025 To ensure synchronization of this process between the encoder and decoder, each
4026  SILK frame stores a 2-bit seed after the LTP parameters (if any).
4027 The encoder may consider the choice of seed during quantization, and the
4028  flexibility of this choice lets it reduce distortion, helping to pay for the
4029  bit cost required to signal it.
4030 The decoder reads the seed using the uniform 4-entry PDF in
4031  <xref target="silk_seed_pdf"/>, yielding a value between 0 and 3, inclusive.
4032 </t>
4033
4034 <texttable anchor="silk_seed_pdf"
4035  title="PDF for LCG Seed">
4036 <ttcol align="left">PDF</ttcol>
4037 <c>{64, 64, 64, 64}/256</c>
4038 </texttable>
4039
4040 </section>
4041
4042 <section anchor="silk_excitation" toc="include" title="Excitation">
4043 <t>
4044 SILK codes the excitation using a modified version of the Pyramid Vector
4045  Quantization (PVQ) codebook <xref target="PVQ"/>.
4046 The PVQ codebook is designed for Laplace-distributed values and consists of all
4047  sums of K signed, unit pulses in a vector of dimension N, where two pulses at
4048  the same position are required to have the same sign.
4049 Thus the codebook includes all integer codevectors y of dimension N that
4050  satisfy
4051 <figure align="center">
4052 <artwork align="center"><![CDATA[
4053 N-1
4054 __
4055 \  abs(y[j