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