Update draft: addressing AD comments
[opus.git] / doc / draft-ietf-codec-opus-update.xml
1 <?xml version="1.0" encoding="US-ASCII"?>
2 <!DOCTYPE rfc SYSTEM "rfc2629.dtd">
3 <?rfc toc="yes"?>
4 <?rfc tocompact="yes"?>
5 <?rfc tocdepth="3"?>
6 <?rfc tocindent="yes"?>
7 <?rfc symrefs="yes"?>
8 <?rfc sortrefs="yes"?>
9 <?rfc comments="yes"?>
10 <?rfc inline="yes"?>
11 <?rfc compact="yes"?>
12 <?rfc subcompact="no"?>
13 <rfc category="std" docName="draft-ietf-codec-opus-update-08"
14      ipr="trust200902" updates="6716">
15   <front>
16     <title abbrev="Opus Update">Updates to the Opus Audio Codec</title>
17
18 <author initials="JM" surname="Valin" fullname="Jean-Marc Valin">
19 <organization>Mozilla Corporation</organization>
20 <address>
21 <postal>
22 <street>331 E. Evelyn Avenue</street>
23 <city>Mountain View</city>
24 <region>CA</region>
25 <code>94041</code>
26 <country>USA</country>
27 </postal>
28 <phone>+1 650 903-0800</phone>
29 <email>jmvalin@jmvalin.ca</email>
30 </address>
31 </author>
32
33 <author initials="K." surname="Vos" fullname="Koen Vos">
34 <organization>vocTone</organization>
35 <address>
36 <postal>
37 <street></street>
38 <city></city>
39 <region></region>
40 <code></code>
41 <country></country>
42 </postal>
43 <phone></phone>
44 <email>koenvos74@gmail.com</email>
45 </address>
46 </author>
47
48
49
50     <date day="26" month="July" year="2017" />
51
52     <abstract>
53       <t>This document addresses minor issues that were found in the specification
54       of the Opus audio codec in RFC 6716.</t>
55     </abstract>
56   </front>
57
58   <middle>
59     <section title="Introduction">
60       <t>This document addresses minor issues that were discovered in the reference
61       implementation of the Opus codec. Unlike most IETF specifications, Opus is defined
62       in <xref target="RFC6716">RFC 6716</xref> in terms of a normative reference
63       decoder implementation rather than from the associated text description.
64       That RFC includes the reference decoder implementation as Appendix A.
65       That's why only issues affecting the decoder are
66       listed here. An up-to-date implementation of the Opus encoder can be found at
67       <eref target="https://opus-codec.org/"/>.</t>
68     <t>
69       Some of the changes in this document update normative behaviour in a way that requires
70       new test vectors. The English text of the specification is unaffected, only
71       the C implementation is. The updated specification remains fully compatible with
72       the original specification.
73     </t>
74
75     <t>
76     Note: due to RFC formatting conventions, lines exceeding the column width
77     in the patch are split using a backslash character. The backslashes
78     at the end of a line and the white space at the beginning
79     of the following line are not part of the patch. A properly formatted patch
80     including all changes is available at
81     <eref target="https://www.ietf.org/proceedings/98/slides/materials-98-codec-opus-update-00.patch"/>
82     and has a SHA1 029e3aa88fc342c91e67a21e7bfbc9458661cd5f.
83     </t>
84
85     </section>
86
87     <section title="Terminology">
88       <t>The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT",
89       "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this
90       document are to be interpreted as described in <xref
91       target="RFC2119">RFC 2119</xref>.</t>
92     </section>
93
94     <section title="Stereo State Reset in SILK">
95       <t>The reference implementation does not reinitialize the stereo state
96       during a mode switch. The old stereo memory can produce a brief impulse
97       (i.e. single sample) in the decoded audio. This can be fixed by changing
98       silk/dec_API.c at line 72:
99     </t>
100 <figure>
101 <artwork><![CDATA[
102 <CODE BEGINS>
103      for( n = 0; n < DECODER_NUM_CHANNELS; n++ ) {
104          ret  = silk_init_decoder( &channel_state[ n ] );
105      }
106 +    silk_memset(&((silk_decoder *)decState)->sStereo, 0,
107 +                sizeof(((silk_decoder *)decState)->sStereo));
108 +    /* Not strictly needed, but it's cleaner that way */
109 +    ((silk_decoder *)decState)->prev_decode_only_middle = 0;
110  
111      return ret;
112  }
113 <CODE ENDS>
114 ]]></artwork>
115 </figure>
116      <t>
117      This change affects the normative output of the decoder, but the
118      amount of change is within the tolerance and too small to make the testvector check fail.
119       </t>
120     </section>
121
122     <section anchor="padding" title="Parsing of the Opus Packet Padding">
123       <t>It was discovered that some invalid packets of very large size could trigger
124       an out-of-bounds read in the Opus packet parsing code responsible for padding.
125       This is due to an integer overflow if the signaled padding exceeds 2^31-1 bytes
126       (the actual packet may be smaller). The code can be fixed by applying the following
127       changes at line 596 of src/opus_decoder.c:
128     </t>
129 <figure>
130 <artwork><![CDATA[
131 <CODE BEGINS>
132        /* Padding flag is bit 6 */
133        if (ch&0x40)
134        {
135 -         int padding=0;
136           int p;
137           do {
138              if (len<=0)
139                 return OPUS_INVALID_PACKET;
140              p = *data++;
141              len--;
142 -            padding += p==255 ? 254: p;
143 +            len -= p==255 ? 254: p;
144           } while (p==255);
145 -         len -= padding;
146        }
147 <CODE ENDS>
148 ]]></artwork>
149 </figure>
150       <t>This packet parsing issue is limited to reading memory up
151          to about 60 kB beyond the compressed buffer. This can only be triggered
152          by a compressed packet more than about 16 MB long, so it's not a problem
153          for RTP. In theory, it could crash a file
154          decoder (e.g. Opus in Ogg) if the memory just after the incoming packet
155          is out-of-range, but our attempts to trigger such a crash in a production
156          application built using an affected version of the Opus decoder failed.</t>
157     </section>
158
159     <section anchor="resampler" title="Resampler buffer">
160       <t>The SILK resampler had the following issues:
161         <list style="numbers">
162     <t>The calls to memcpy() were using sizeof(opus_int32), but the type of the
163         local buffer was opus_int16.</t>
164     <t>Because the size was wrong, this potentially allowed the source
165         and destination regions of the memcpy() to overlap.
166           We believe that nSamplesIn (number of input samples) is at least fs_in_khZ (sampling rate in kHz),
167           which is at least 8.
168        Since RESAMPLER_ORDER_FIR_12 is only 8, that should not be a problem once
169        the type size is fixed.</t>
170           <t>The size of the buffer used RESAMPLER_MAX_BATCH_SIZE_IN, but the
171         data stored in it was actually twice the input batch size
172         (nSamplesIn&lt;&lt;1).</t>
173       </list></t>
174       <t>
175       The fact that the code never produced any error in testing (including when run under the
176       Valgrind memory debugger), suggests that in practice
177      the batch sizes are reasonable enough that none of the issues above
178      was ever a problem. However, the authors know of no obvious approach to proving that.
179     </t>
180     <t>The code can be fixed by applying the following changes to line 78 of silk/resampler_private_IIR_FIR.c:
181     </t>
182 <figure>
183 <artwork><![CDATA[
184 <CODE BEGINS>
185  )
186  {
187      silk_resampler_state_struct *S = \
188 (silk_resampler_state_struct *)SS;
189      opus_int32 nSamplesIn;
190      opus_int32 max_index_Q16, index_increment_Q16;
191 -    opus_int16 buf[ RESAMPLER_MAX_BATCH_SIZE_IN + \
192 RESAMPLER_ORDER_FIR_12 ];
193 +    opus_int16 buf[ 2*RESAMPLER_MAX_BATCH_SIZE_IN + \
194 RESAMPLER_ORDER_FIR_12 ];
195  
196      /* Copy buffered samples to start of buffer */
197 -    silk_memcpy( buf, S->sFIR, RESAMPLER_ORDER_FIR_12 \
198 * sizeof( opus_int32 ) );
199 +    silk_memcpy( buf, S->sFIR, RESAMPLER_ORDER_FIR_12 \
200 * sizeof( opus_int16 ) );
201  
202      /* Iterate over blocks of frameSizeIn input samples */
203      index_increment_Q16 = S->invRatio_Q16;
204      while( 1 ) {
205          nSamplesIn = silk_min( inLen, S->batchSize );
206  
207          /* Upsample 2x */
208          silk_resampler_private_up2_HQ( S->sIIR, &buf[ \
209 RESAMPLER_ORDER_FIR_12 ], in, nSamplesIn );
210  
211          max_index_Q16 = silk_LSHIFT32( nSamplesIn, 16 + 1 \
212 );         /* + 1 because 2x upsampling */
213          out = silk_resampler_private_IIR_FIR_INTERPOL( out, \
214 buf, max_index_Q16, index_increment_Q16 );
215          in += nSamplesIn;
216          inLen -= nSamplesIn;
217  
218          if( inLen > 0 ) {
219              /* More iterations to do; copy last part of \
220 filtered signal to beginning of buffer */
221 -            silk_memcpy( buf, &buf[ nSamplesIn << 1 ], \
222 RESAMPLER_ORDER_FIR_12 * sizeof( opus_int32 ) );
223 +            silk_memmove( buf, &buf[ nSamplesIn << 1 ], \
224 RESAMPLER_ORDER_FIR_12 * sizeof( opus_int16 ) );
225          } else {
226              break;
227          }
228      }
229  
230      /* Copy last part of filtered signal to the state for \
231 the next call */
232 -    silk_memcpy( S->sFIR, &buf[ nSamplesIn << 1 ], \
233 RESAMPLER_ORDER_FIR_12 * sizeof( opus_int32 ) );
234 +    silk_memcpy( S->sFIR, &buf[ nSamplesIn << 1 ], \
235 RESAMPLER_ORDER_FIR_12 * sizeof( opus_int16 ) );
236  }
237 <CODE ENDS>
238 ]]></artwork>
239 </figure>
240     </section>
241
242     <section title="Integer wrap-around in inverse gain computation">
243       <t>
244         It was discovered through decoder fuzzing that some bitstreams could produce
245         integer values exceeding 32-bits in LPC_inverse_pred_gain_QA(), causing
246         a wrap-around. Although the error is harmless in practice, the C standard considers
247         the behavior as undefined, so the following patch to line 87 of silk/LPC_inv_pred_gain.c
248         detects values that do not fit in a 32-bit integer and considers the corresponding filters unstable:
249       </t>
250 <figure>
251 <artwork><![CDATA[
252 <CODE BEGINS>
253          /* Update AR coefficient */
254          for( n = 0; n < k; n++ ) {
255 -            tmp_QA = Aold_QA[ n ] - MUL32_FRAC_Q( \
256 Aold_QA[ k - n - 1 ], rc_Q31, 31 );
257 -            Anew_QA[ n ] = MUL32_FRAC_Q( tmp_QA, rc_mult2 , mult2Q );
258 +            opus_int64 tmp64;
259 +            tmp_QA = silk_SUB_SAT32( Aold_QA[ n ], MUL32_FRAC_Q( \
260 Aold_QA[ k - n - 1 ], rc_Q31, 31 ) );
261 +            tmp64 = silk_RSHIFT_ROUND64( silk_SMULL( tmp_QA, \
262 rc_mult2 ), mult2Q);
263 +            if( tmp64 > silk_int32_MAX || tmp64 < silk_int32_MIN ) {
264 +               return 0;
265 +            }
266 +            Anew_QA[ n ] = ( opus_int32 )tmp64;
267          }
268 <CODE ENDS>
269 ]]></artwork>
270 </figure>
271     </section>
272
273     <section title="Integer wrap-around in LSF decoding" anchor="lsf_overflow">
274       <t>
275         It was discovered -- also from decoder fuzzing -- that an integer wrap-around could
276         occur when decoding line spectral frequency coefficients from extreme bitstreams.
277         The end result of the wrap-around is an illegal read access on the stack, which
278         the authors do not believe is exploitable but should nonetheless be fixed. The following
279         patch to line 137 of silk/NLSF_stabilize.c prevents the problem:
280       </t>
281 <figure>
282 <artwork><![CDATA[
283 <CODE BEGINS>
284            /* Keep delta_min distance between the NLSFs */
285          for( i = 1; i < L; i++ )
286 -            NLSF_Q15[i] = silk_max_int( NLSF_Q15[i], \
287 NLSF_Q15[i-1] + NDeltaMin_Q15[i] );
288 +            NLSF_Q15[i] = silk_max_int( NLSF_Q15[i], \
289 silk_ADD_SAT16( NLSF_Q15[i-1], NDeltaMin_Q15[i] ) );
290  
291          /* Last NLSF should be no higher than 1 - NDeltaMin[L] */
292 <CODE ENDS>
293 ]]></artwork>
294 </figure>
295
296     </section>
297
298     <section title="Cap on Band Energy">
299       <t>On extreme bit-streams, it is possible for log-domain band energy levels
300         to exceed the maximum single-precision floating point value once converted
301         to a linear scale. This would later cause the decoded values to be NaN (not a number),
302         possibly causing problems in the software using the PCM values. This can be
303         avoided with the following patch to line 552 of celt/quant_bands.c:
304       </t>
305 <figure>
306 <artwork><![CDATA[
307 <CODE BEGINS>
308        {
309           opus_val16 lg = ADD16(oldEBands[i+c*m->nbEBands],
310                           SHL16((opus_val16)eMeans[i],6));
311 +         lg = MIN32(QCONST32(32.f, 16), lg);
312           eBands[i+c*m->nbEBands] = PSHR32(celt_exp2(lg),4);
313        }
314        for (;i<m->nbEBands;i++)
315 <CODE ENDS>
316 ]]></artwork>
317 </figure>
318     </section>
319
320     <section title="Hybrid Folding" anchor="folding">
321       <t>When encoding in hybrid mode at low bitrate, we sometimes only have
322         enough bits to code a single CELT band (8 - 9.6 kHz). When that happens,
323         the second band (CELT band 18, from 9.6 to 12 kHz) cannot use folding
324         because it is wider than the amount already coded, and falls back to
325         white noise. Because it can also happen on transients (e.g. stops), it
326         can cause audible pre-echo.
327       </t>
328       <t>
329         To address the issue, we change the folding behavior so that it is
330         never forced to fall back to LCG due to the first band not containing
331         enough coefficients to fold onto the second band. This
332         is achieved by simply repeating part of the first band in the folding
333         of the second band. This changes the code in celt/bands.c around line 1237:
334       </t>
335 <figure>
336 <artwork><![CDATA[
337 <CODE BEGINS>
338           b = 0;
339        }
340  
341 -      if (resynth && M*eBands[i]-N >= M*eBands[start] && \
342 (update_lowband || lowband_offset==0))
343 +      if (resynth && (M*eBands[i]-N >= M*eBands[start] || \
344 i==start+1) && (update_lowband || lowband_offset==0))
345              lowband_offset = i;
346  
347 +      if (i == start+1)
348 +      {
349 +         int n1, n2;
350 +         int offset;
351 +         n1 = M*(eBands[start+1]-eBands[start]);
352 +         n2 = M*(eBands[start+2]-eBands[start+1]);
353 +         offset = M*eBands[start];
354 +         /* Duplicate enough of the first band folding data to \
355 be able to fold the second band.
356 +            Copies no data for CELT-only mode. */
357 +         OPUS_COPY(&norm[offset+n1], &norm[offset+2*n1 - n2], n2-n1);
358 +         if (C==2)
359 +            OPUS_COPY(&norm2[offset+n1], &norm2[offset+2*n1 - n2], \
360 n2-n1);
361 +      }
362 +
363        tf_change = tf_res[i];
364        if (i>=m->effEBands)
365        {
366 <CODE ENDS>
367 ]]></artwork>
368 </figure>
369
370       <t>
371        as well as line 1260:
372       </t>
373
374 <figure>
375 <artwork><![CDATA[
376 <CODE BEGINS>
377           fold_start = lowband_offset;
378           while(M*eBands[--fold_start] > effective_lowband);
379           fold_end = lowband_offset-1;
380 -         while(M*eBands[++fold_end] < effective_lowband+N);
381 +         while(++fold_end < i && M*eBands[fold_end] < \
382 effective_lowband+N);
383           x_cm = y_cm = 0;
384           fold_i = fold_start; do {
385             x_cm |= collapse_masks[fold_i*C+0];
386
387 <CODE ENDS>
388 ]]></artwork>
389 </figure>
390       <t>
391         The fix does not impact compatibility, because the improvement does
392         not depend on the encoder doing anything special. There is also no
393         reasonable way for an encoder to use the original behavior to
394         improve quality over the proposed change.
395       </t>
396     </section>
397
398     <section title="Downmix to Mono" anchor="stereo">
399       <t>The last issue is not strictly a bug, but it is an issue that has been reported
400       when downmixing an Opus decoded stream to mono, whether this is done inside the decoder
401       or as a post-processing step on the stereo decoder output. Opus intensity stereo allows
402       optionally coding the two channels 180-degrees out of phase on a per-band basis.
403       This provides better stereo quality than forcing the two channels to be in phase,
404       but when the output is downmixed to mono, the energy in the affected bands is cancelled
405       sometimes resulting in audible artefacts.
406       </t>
407       <t>As a work-around for this issue, the decoder MAY choose not to apply the 180-degree
408       phase shift when the output is meant to be downmixed (inside or
409       outside of the decoder).
410       </t>
411     </section>
412
413
414     <section title="New Test Vectors">
415       <t>Changes in <xref target="folding"/> and <xref target="stereo"/> have
416         sufficient impact on the testvectors to make them fail. For this reason,
417         this document also updates the Opus test vectors. The new test vectors now
418         include two decoded outputs for the same bitstream. The outputs with
419         suffix 'm' do not apply the CELT 180-degree phase shift as allowed in
420         <xref target="stereo"/>, while the outputs without the suffix do. An
421         implementation is compliant as long as it passes either set of vectors.
422       </t>
423       <t>
424         In addition, any Opus implementation
425         that passes the original test vectors from <xref target="RFC6716">RFC 6716</xref>
426         is still compliant with the Opus specification. However, newer implementations
427         SHOULD be based on the new test vectors rather than the old ones.
428       </t>
429       <t>The new test vectors are located at
430         <eref target="https://www.ietf.org/proceedings/98/slides/materials-98-codec-opus-newvectors-00.tar.gz"/>.
431         The SHA1 hash of the test vectors are:
432 <figure>
433 <artwork>
434 <![CDATA[
435 e49b2862ceec7324790ed8019eb9744596d5be01  testvector01.bit
436 b809795ae1bcd606049d76de4ad24236257135e0  testvector02.bit
437 e0c4ecaeab44d35a2f5b6575cd996848e5ee2acc  testvector03.bit
438 a0f870cbe14ebb71fa9066ef3ee96e59c9a75187  testvector04.bit
439 9b3d92b48b965dfe9edf7b8a85edd4309f8cf7c8  testvector05.bit
440 28e66769ab17e17f72875283c14b19690cbc4e57  testvector06.bit
441 bacf467be3215fc7ec288f29e2477de1192947a6  testvector07.bit
442 ddbe08b688bbf934071f3893cd0030ce48dba12f  testvector08.bit
443 3932d9d61944dab1201645b8eeaad595d5705ecb  testvector09.bit
444 521eb2a1e0cc9c31b8b740673307c2d3b10c1900  testvector10.bit
445 6bc8f3146fcb96450c901b16c3d464ccdf4d5d96  testvector11.bit
446 338c3f1b4b97226bc60bc41038becbc6de06b28f  testvector12.bit
447 f5ef93884da6a814d311027918e9afc6f2e5c2c8  testvector01.dec
448 48ac1ff1995250a756e1e17bd32acefa8cd2b820  testvector02.dec
449 d15567e919db2d0e818727092c0af8dd9df23c95  testvector03.dec
450 1249dd28f5bd1e39a66fd6d99449dca7a8316342  testvector04.dec
451 b85675d81deef84a112c466cdff3b7aaa1d2fc76  testvector05.dec
452 55f0b191e90bfa6f98b50d01a64b44255cb4813e  testvector06.dec
453 61e8b357ab090b1801eeb578a28a6ae935e25b7b  testvector07.dec
454 a58539ee5321453b2ddf4c0f2500e856b3966862  testvector08.dec
455 bb96aad2cde188555862b7bbb3af6133851ef8f4  testvector09.dec
456 1b6cdf0413ac9965b16184b1bea129b5c0b2a37a  testvector10.dec
457 b1fff72b74666e3027801b29dbc48b31f80dee0d  testvector11.dec
458 98e09bbafed329e341c3b4052e9c4ba5fc83f9b1  testvector12.dec
459 1e7d984ea3fbb16ba998aea761f4893fbdb30157  testvector01m.dec
460 48ac1ff1995250a756e1e17bd32acefa8cd2b820  testvector02m.dec
461 d15567e919db2d0e818727092c0af8dd9df23c95  testvector03m.dec
462 1249dd28f5bd1e39a66fd6d99449dca7a8316342  testvector04m.dec
463 d70b0bad431e7d463bc3da49bd2d49f1c6d0a530  testvector05m.dec
464 6ac1648c3174c95fada565161a6c78bdbe59c77d  testvector06m.dec
465 fc5e2f709693738324fb4c8bdc0dad6dda04e713  testvector07m.dec
466 aad2ba397bf1b6a18e8e09b50e4b19627d479f00  testvector08m.dec
467 6feb7a7b9d7cdc1383baf8d5739e2a514bd0ba08  testvector09m.dec
468 1b6cdf0413ac9965b16184b1bea129b5c0b2a37a  testvector10m.dec
469 fd3d3a7b0dfbdab98d37ed9aa04b659b9fefbd18  testvector11m.dec
470 98e09bbafed329e341c3b4052e9c4ba5fc83f9b1  testvector12m.dec
471 ]]>
472 </artwork>
473 </figure>
474       Note that the decoder input bitstream files (.bit) are unchanged.
475       </t>
476     </section>
477
478     <section anchor="security" title="Security Considerations">
479       <t>This document fixes two security issues reported on Opus and that affect the
480         reference implementation in <xref target="RFC6716">RFC 6716</xref>: CVE-2013-0899
481         <eref target="https://nvd.nist.gov/vuln/detail/CVE-2013-0899"/>
482         and CVE-2017-0381 <eref target="https://nvd.nist.gov/vuln/detail/CVE-2017-0381"/>.
483         CVE-2013-0899 is fixed by <xref target="padding"/> and
484         could theoretically cause information leak, but the
485         leaked information would at the very least go through the decoder process before
486         being accessible to the attacker. Also, the bug can only be triggered by Opus packets
487         at least 24 MB in size. CVE-2017-0381 is fixed by <xref target="lsf_overflow"/> and, as far
488         as the authors are aware, could not be exploited in any way (despite the claims in
489         the CVE) unless the read-only table
490         was somehow placed very close to sensitive data, which is highly unlikely.
491         Beyond the two fixed CVEs, this document adds no new security considerations on top of
492         <xref target="RFC6716">RFC 6716</xref>.
493       </t>
494     </section>
495
496     <section anchor="IANA" title="IANA Considerations">
497       <t>This document makes no request of IANA.</t>
498
499       <t>Note to RFC Editor: this section may be removed on publication as an
500       RFC.</t>
501     </section>
502
503     <section anchor="Acknowledgements" title="Acknowledgements">
504       <t>We would like to thank Juri Aedla for reporting the issue with the parsing of
505       the Opus padding. Thanks to Felicia Lim for reporting the LSF integer overflow issue.
506       Also, thanks to Tina le Grand, Jonathan Lennox, and Mark Harris for their
507       feedback on this document.</t>
508     </section>
509   </middle>
510
511   <back>
512     <references title="Normative References">
513       <?rfc include="http://xml.resource.org/public/rfc/bibxml/reference.RFC.2119.xml"?>
514       <?rfc include="http://xml.resource.org/public/rfc/bibxml/reference.RFC.6716.xml"?>
515
516
517     </references>
518   </back>
519 </rfc>