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