Update links, fix bits, add security considerations
[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-07"
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="16" 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 that serves as the specification in
62       <xref target="RFC6716">RFC 6716</xref>. Only issues affecting the decoder are
63       listed here. An up-to-date implementation of the Opus encoder can be found at
64       <eref target="https://opus-codec.org/"/>.</t>
65     <t>
66       Some of the changes in this document update normative behaviour in a way that requires
67       new test vectors. The English text of the specification is unaffected, only
68       the C implementation is. The updated specification remains fully compatible with
69       the original specification.
70     </t>
71
72     <t>
73     Note: due to RFC formatting conventions, lines exceeding the column width
74     in the patch are split using a backslash character. The backslashes
75     at the end of a line and the white space at the beginning
76     of the following line are not part of the patch. A properly formatted patch
77     including all changes is available at
78     <eref target="https://www.ietf.org/proceedings/98/slides/materials-98-codec-opus-update-00.patch"/>.
79     </t>
80
81     </section>
82
83     <section title="Terminology">
84       <t>The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT",
85       "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this
86       document are to be interpreted as described in <xref
87       target="RFC2119">RFC 2119</xref>.</t>
88     </section>
89
90     <section title="Stereo State Reset in SILK">
91       <t>The reference implementation does not reinitialize the stereo state
92       during a mode switch. The old stereo memory can produce a brief impulse
93       (i.e. single sample) in the decoded audio. This can be fixed by changing
94       silk/dec_API.c at line 72:
95     </t>
96 <figure>
97 <artwork><![CDATA[
98 <CODE BEGINS>
99      for( n = 0; n < DECODER_NUM_CHANNELS; n++ ) {
100          ret  = silk_init_decoder( &channel_state[ n ] );
101      }
102 +    silk_memset(&((silk_decoder *)decState)->sStereo, 0,
103 +                sizeof(((silk_decoder *)decState)->sStereo));
104 +    /* Not strictly needed, but it's cleaner that way */
105 +    ((silk_decoder *)decState)->prev_decode_only_middle = 0;
106  
107      return ret;
108  }
109 <CODE ENDS>
110 ]]></artwork>
111 </figure>
112      <t>
113      This change affects the normative part of the decoder, although the
114      amount of change is too small to make a significant impact on testvectors.
115       </t>
116     </section>
117
118     <section anchor="padding" title="Parsing of the Opus Packet Padding">
119       <t>It was discovered that some invalid packets of very large size could trigger
120       an out-of-bounds read in the Opus packet parsing code responsible for padding.
121       This is due to an integer overflow if the signaled padding exceeds 2^31-1 bytes
122       (the actual packet may be smaller). The code can be fixed by applying the following
123       changes at line 596 of src/opus_decoder.c:
124     </t>
125 <figure>
126 <artwork><![CDATA[
127 <CODE BEGINS>
128        /* Padding flag is bit 6 */
129        if (ch&0x40)
130        {
131 -         int padding=0;
132           int p;
133           do {
134              if (len<=0)
135                 return OPUS_INVALID_PACKET;
136              p = *data++;
137              len--;
138 -            padding += p==255 ? 254: p;
139 +            len -= p==255 ? 254: p;
140           } while (p==255);
141 -         len -= padding;
142        }
143 <CODE ENDS>
144 ]]></artwork>
145 </figure>
146       <t>This packet parsing issue is limited to reading memory up
147          to about 60 kB beyond the compressed buffer. This can only be triggered
148          by a compressed packet more than about 16 MB long, so it's not a problem
149          for RTP. In theory, it <spanx style="emph">could</spanx> crash a file
150          decoder (e.g. Opus in Ogg) if the memory just after the incoming packet
151          is out-of-range, but our attempts to trigger such a crash in a production
152          application built using an affected version of the Opus decoder failed.</t>
153     </section>
154
155     <section anchor="resampler" title="Resampler buffer">
156       <t>The SILK resampler had the following issues:
157         <list style="numbers">
158     <t>The calls to memcpy() were using sizeof(opus_int32), but the type of the
159         local buffer was opus_int16.</t>
160     <t>Because the size was wrong, this potentially allowed the source
161         and destination regions of the memcpy() to overlap.
162           We <spanx style="emph">believe</spanx> that nSamplesIn is at least fs_in_khZ,
163           which is at least 8.
164        Since RESAMPLER_ORDER_FIR_12 is only 8, that should not be a problem once
165        the type size is fixed.</t>
166           <t>The size of the buffer used RESAMPLER_MAX_BATCH_SIZE_IN, but the
167         data stored in it was actually _twice_ the input batch size
168         (nSamplesIn&lt;&lt;1).</t>
169       </list></t>
170       <t>
171       The fact that the code never produced any error in testing (including when run under the
172       Valgrind memory debugger), suggests that in practice
173      the batch sizes are reasonable enough that none of the issues above
174      was ever a problem. However, proving that is non-obvious.
175     </t>
176     <t>The code can be fixed by applying the following changes to line 78 of silk/resampler_private_IIR_FIR.c:
177     </t>
178 <figure>
179 <artwork><![CDATA[
180 <CODE BEGINS>
181  )
182  {
183      silk_resampler_state_struct *S = \
184 (silk_resampler_state_struct *)SS;
185      opus_int32 nSamplesIn;
186      opus_int32 max_index_Q16, index_increment_Q16;
187 -    opus_int16 buf[ RESAMPLER_MAX_BATCH_SIZE_IN + \
188 RESAMPLER_ORDER_FIR_12 ];
189 +    opus_int16 buf[ 2*RESAMPLER_MAX_BATCH_SIZE_IN + \
190 RESAMPLER_ORDER_FIR_12 ];
191  
192      /* Copy buffered samples to start of buffer */
193 -    silk_memcpy( buf, S->sFIR, RESAMPLER_ORDER_FIR_12 \
194 * sizeof( opus_int32 ) );
195 +    silk_memcpy( buf, S->sFIR, RESAMPLER_ORDER_FIR_12 \
196 * sizeof( opus_int16 ) );
197  
198      /* Iterate over blocks of frameSizeIn input samples */
199      index_increment_Q16 = S->invRatio_Q16;
200      while( 1 ) {
201          nSamplesIn = silk_min( inLen, S->batchSize );
202  
203          /* Upsample 2x */
204          silk_resampler_private_up2_HQ( S->sIIR, &buf[ \
205 RESAMPLER_ORDER_FIR_12 ], in, nSamplesIn );
206  
207          max_index_Q16 = silk_LSHIFT32( nSamplesIn, 16 + 1 \
208 );         /* + 1 because 2x upsampling */
209          out = silk_resampler_private_IIR_FIR_INTERPOL( out, \
210 buf, max_index_Q16, index_increment_Q16 );
211          in += nSamplesIn;
212          inLen -= nSamplesIn;
213  
214          if( inLen > 0 ) {
215              /* More iterations to do; copy last part of \
216 filtered signal to beginning of buffer */
217 -            silk_memcpy( buf, &buf[ nSamplesIn << 1 ], \
218 RESAMPLER_ORDER_FIR_12 * sizeof( opus_int32 ) );
219 +            silk_memmove( buf, &buf[ nSamplesIn << 1 ], \
220 RESAMPLER_ORDER_FIR_12 * sizeof( opus_int16 ) );
221          } else {
222              break;
223          }
224      }
225  
226      /* Copy last part of filtered signal to the state for \
227 the next call */
228 -    silk_memcpy( S->sFIR, &buf[ nSamplesIn << 1 ], \
229 RESAMPLER_ORDER_FIR_12 * sizeof( opus_int32 ) );
230 +    silk_memcpy( S->sFIR, &buf[ nSamplesIn << 1 ], \
231 RESAMPLER_ORDER_FIR_12 * sizeof( opus_int16 ) );
232  }
233 <CODE ENDS>
234 ]]></artwork>
235 </figure>
236     </section>
237
238     <section title="Integer wrap-around in inverse gain computation">
239       <t>
240         It was discovered through decoder fuzzing that some bitstreams could produce
241         integer values exceeding 32-bits in LPC_inverse_pred_gain_QA(), causing
242         a wrap-around. Although the error is harmless in practice, the C standard considers
243         the behavior as undefined, so the following patch to line 87 of silk/LPC_inv_pred_gain.c
244         detects values that do not fit in a 32-bit integer and considers the corresponding filters unstable:
245       </t>
246 <figure>
247 <artwork><![CDATA[
248 <CODE BEGINS>
249          /* Update AR coefficient */
250          for( n = 0; n < k; n++ ) {
251 -            tmp_QA = Aold_QA[ n ] - MUL32_FRAC_Q( \
252 Aold_QA[ k - n - 1 ], rc_Q31, 31 );
253 -            Anew_QA[ n ] = MUL32_FRAC_Q( tmp_QA, rc_mult2 , mult2Q );
254 +            opus_int64 tmp64;
255 +            tmp_QA = silk_SUB_SAT32( Aold_QA[ n ], MUL32_FRAC_Q( \
256 Aold_QA[ k - n - 1 ], rc_Q31, 31 ) );
257 +            tmp64 = silk_RSHIFT_ROUND64( silk_SMULL( tmp_QA, \
258 rc_mult2 ), mult2Q);
259 +            if( tmp64 > silk_int32_MAX || tmp64 < silk_int32_MIN ) {
260 +               return 0;
261 +            }
262 +            Anew_QA[ n ] = ( opus_int32 )tmp64;
263          }
264 <CODE ENDS>
265 ]]></artwork>
266 </figure>
267     </section>
268
269     <section title="Integer wrap-around in LSF decoding">
270       <t>
271         It was discovered -- also from decoder fuzzing -- that an integer wrap-around could
272         occur when decoding line spectral frequency coefficients from extreme bitstreams.
273         The end result of the wrap-around is an illegal read access on the stack, which
274         the authors do not believe is exploitable but should nonetheless be fixed. The following
275         patch to line 137 of silk/NLSF_stabilize.c prevents the problem:
276       </t>
277 <figure>
278 <artwork><![CDATA[
279 <CODE BEGINS>
280            /* Keep delta_min distance between the NLSFs */
281          for( i = 1; i < L; i++ )
282 -            NLSF_Q15[i] = silk_max_int( NLSF_Q15[i], \
283 NLSF_Q15[i-1] + NDeltaMin_Q15[i] );
284 +            NLSF_Q15[i] = silk_max_int( NLSF_Q15[i], \
285 silk_ADD_SAT16( NLSF_Q15[i-1], NDeltaMin_Q15[i] ) );
286  
287          /* Last NLSF should be no higher than 1 - NDeltaMin[L] */
288 <CODE ENDS>
289 ]]></artwork>
290 </figure>
291
292     </section>
293
294     <section title="Cap on Band Energy">
295       <t>On extreme bit-streams, it is possible for log-domain band energy levels
296         to exceed the maximum single-precision floating point value once converted
297         to a linear scale. This would later cause the decoded values to be NaN,
298         possibly causing problems in the software using the PCM values. This can be
299         avoided with the following patch to line 552 of celt/quant_bands.c:
300       </t>
301 <figure>
302 <artwork><![CDATA[
303 <CODE BEGINS>
304        {
305           opus_val16 lg = ADD16(oldEBands[i+c*m->nbEBands],
306                           SHL16((opus_val16)eMeans[i],6));
307 +         lg = MIN32(QCONST32(32.f, 16), lg);
308           eBands[i+c*m->nbEBands] = PSHR32(celt_exp2(lg),4);
309        }
310        for (;i<m->nbEBands;i++)
311 <CODE ENDS>
312 ]]></artwork>
313 </figure>
314     </section>
315
316     <section title="Hybrid Folding" anchor="folding">
317       <t>When encoding in hybrid mode at low bitrate, we sometimes only have
318         enough bits to code a single CELT band (8 - 9.6 kHz). When that happens,
319         the second band (CELT band 18, from 9.6 to 12 kHz) cannot use folding
320         because it is wider than the amount already coded, and falls back to
321         LCG noise. Because it can also happen on transients (e.g. stops), it
322         can cause audible pre-echo.
323       </t>
324       <t>
325         To address the issue, we change the folding behavior so that it is
326         never forced to fall back to LCG due to the first band not containing
327         enough coefficients to fold onto the second band. This
328         is achieved by simply repeating part of the first band in the folding
329         of the second band. This changes the code in celt/bands.c around line 1237:
330       </t>
331 <figure>
332 <artwork><![CDATA[
333 <CODE BEGINS>
334           b = 0;
335        }
336  
337 -      if (resynth && M*eBands[i]-N >= M*eBands[start] && \
338 (update_lowband || lowband_offset==0))
339 +      if (resynth && (M*eBands[i]-N >= M*eBands[start] || \
340 i==start+1) && (update_lowband || lowband_offset==0))
341              lowband_offset = i;
342  
343 +      if (i == start+1)
344 +      {
345 +         int n1, n2;
346 +         int offset;
347 +         n1 = M*(eBands[start+1]-eBands[start]);
348 +         n2 = M*(eBands[start+2]-eBands[start+1]);
349 +         offset = M*eBands[start];
350 +         /* Duplicate enough of the first band folding data to \
351 be able to fold the second band.
352 +            Copies no data for CELT-only mode. */
353 +         OPUS_COPY(&norm[offset+n1], &norm[offset+2*n1 - n2], n2-n1);
354 +         if (C==2)
355 +            OPUS_COPY(&norm2[offset+n1], &norm2[offset+2*n1 - n2], \
356 n2-n1);
357 +      }
358 +
359        tf_change = tf_res[i];
360        if (i>=m->effEBands)
361        {
362 <CODE ENDS>
363 ]]></artwork>
364 </figure>
365
366       <t>
367        as well as line 1260:
368       </t>
369
370 <figure>
371 <artwork><![CDATA[
372 <CODE BEGINS>
373           fold_start = lowband_offset;
374           while(M*eBands[--fold_start] > effective_lowband);
375           fold_end = lowband_offset-1;
376 -         while(M*eBands[++fold_end] < effective_lowband+N);
377 +         while(++fold_end < i && M*eBands[fold_end] < \
378 effective_lowband+N);
379           x_cm = y_cm = 0;
380           fold_i = fold_start; do {
381             x_cm |= collapse_masks[fold_i*C+0];
382
383 <CODE ENDS>
384 ]]></artwork>
385 </figure>
386       <t>
387         The fix does not impact compatibility, because the improvement does
388         not depend on the encoder doing anything special. There is also no
389         reasonable way for an encoder to use the original behavior to
390         improve quality over the proposed change.
391       </t>
392     </section>
393
394     <section title="Downmix to Mono" anchor="stereo">
395       <t>The last issue is not strictly a bug, but it is an issue that has been reported
396       when downmixing an Opus decoded stream to mono, whether this is done inside the decoder
397       or as a post-processing step on the stereo decoder output. Opus intensity stereo allows
398       optionally coding the two channels 180-degrees out of phase on a per-band basis.
399       This provides better stereo quality than forcing the two channels to be in phase,
400       but when the output is downmixed to mono, the energy in the affected bands is cancelled
401       sometimes resulting in audible artefacts.
402       </t>
403       <t>As a work-around for this issue, the decoder MAY choose not to apply the 180-degree
404       phase shift when the output is meant to be downmixed (inside or
405       outside of the decoder).
406       </t>
407     </section>
408
409
410     <section title="New Test Vectors">
411       <t>Changes in <xref target="folding"/> and <xref target="stereo"/> have
412         sufficient impact on the testvectors to make them fail. For this reason,
413         this document also updates the Opus test vectors. The new test vectors now
414         include two decoded outputs for the same bitstream. The outputs with
415         suffix 'm' do not apply the CELT 180-degree phase shift as allowed in
416         <xref target="stereo"/>, while the outputs without the suffix do. An
417         implementation is compliant as long as it passes either set of vectors.
418       </t>
419       <t>
420         In addition, any Opus implementation
421         that passes the original test vectors from <xref target="RFC6716">RFC 6716</xref>
422         is still compliant with the Opus specification. However, newer implementations
423         SHOULD be based on the new test vectors rather than the old ones.
424       </t>
425       <t>The new test vectors are located at
426         <eref target="https://www.ietf.org/proceedings/98/slides/materials-98-codec-opus-newvectors-00.tar.gz"/>.
427       </t>
428     </section>
429
430     <section anchor="security" title="Security Considerations">
431       <t>This document adds no new security considerations on top of
432         <xref target="RFC6716">RFC 6716</xref>.
433       </t>
434     </section>
435
436     <section anchor="IANA" title="IANA Considerations">
437       <t>This document makes no request of IANA.</t>
438
439       <t>Note to RFC Editor: this section may be removed on publication as an
440       RFC.</t>
441     </section>
442
443     <section anchor="Acknowledgements" title="Acknowledgements">
444       <t>We would like to thank Juri Aedla for reporting the issue with the parsing of
445       the Opus padding. Also, thanks to Jonathan Lennox and Mark Harris for their
446       feedback on this document.</t>
447     </section>
448   </middle>
449
450   <back>
451     <references title="Normative References">
452       <?rfc include="http://xml.resource.org/public/rfc/bibxml/reference.RFC.2119.xml"?>
453       <?rfc include="http://xml.resource.org/public/rfc/bibxml/reference.RFC.6716.xml"?>
454
455
456     </references>
457   </back>
458 </rfc>