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