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