Update links, fix bits, add security considerations
[opus.git] / doc / draft-ietf-codec-opus-update.xml
index ea5a7a6..ad0d569 100644 (file)
@@ -10,8 +10,8 @@
 <?rfc inline="yes"?>
 <?rfc compact="yes"?>
 <?rfc subcompact="no"?>
-<rfc category="std" docName="draft-ietf-codec-opus-update-03"
-     ipr="trust200902">
+<rfc category="std" docName="draft-ietf-codec-opus-update-07"
+     ipr="trust200902" updates="6716">
   <front>
     <title abbrev="Opus Update">Updates to the Opus Audio Codec</title>
 
 
 
 
-    <date day="1" month="September" year="2016" />
+    <date day="16" month="July" year="2017" />
 
     <abstract>
       <t>This document addresses minor issues that were found in the specification
-      of the Opus audio codec in <xref target="RFC6716">RFC 6716</xref>.</t>
+      of the Opus audio codec in RFC 6716.</t>
     </abstract>
   </front>
 
       implementation of the Opus codec that serves as the specification in
       <xref target="RFC6716">RFC 6716</xref>. Only issues affecting the decoder are
       listed here. An up-to-date implementation of the Opus encoder can be found at
-      http://opus-codec.org/. The updated specification remains fully compatible with
+      <eref target="https://opus-codec.org/"/>.</t>
+    <t>
+      Some of the changes in this document update normative behaviour in a way that requires
+      new test vectors. The English text of the specification is unaffected, only
+      the C implementation is. The updated specification remains fully compatible with
       the original specification.
-      </t>
+    </t>
+
+    <t>
+    Note: due to RFC formatting conventions, lines exceeding the column width
+    in the patch are split using a backslash character. The backslashes
+    at the end of a line and the white space at the beginning
+    of the following line are not part of the patch. A properly formatted patch
+    including all changes is available at
+    <eref target="https://www.ietf.org/proceedings/98/slides/materials-98-codec-opus-update-00.patch"/>.
+    </t>
+
     </section>
 
     <section title="Terminology">
@@ -81,6 +95,7 @@
     </t>
 <figure>
 <artwork><![CDATA[
+<CODE BEGINS>
      for( n = 0; n < DECODER_NUM_CHANNELS; n++ ) {
          ret  = silk_init_decoder( &channel_state[ n ] );
      }
  
      return ret;
  }
+<CODE ENDS>
 ]]></artwork>
 </figure>
      <t>
     </t>
 <figure>
 <artwork><![CDATA[
+<CODE BEGINS>
        /* Padding flag is bit 6 */
        if (ch&0x40)
        {
           } while (p==255);
 -         len -= padding;
        }
+<CODE ENDS>
 ]]></artwork>
 </figure>
       <t>This packet parsing issue is limited to reading memory up
      the batch sizes are reasonable enough that none of the issues above
      was ever a problem. However, proving that is non-obvious.
     </t>
-    <t>The code can be fixed by applying the following changes to line 70 of silk/resampler_private_IIR_FIR.c:
+    <t>The code can be fixed by applying the following changes to line 78 of silk/resampler_private_IIR_FIR.c:
     </t>
 <figure>
 <artwork><![CDATA[
+<CODE BEGINS>
  )
  {
      silk_resampler_state_struct *S = \
@@ -211,17 +230,9 @@ RESAMPLER_ORDER_FIR_12 * sizeof( opus_int32 ) );
 +    silk_memcpy( S->sFIR, &buf[ nSamplesIn << 1 ], \
 RESAMPLER_ORDER_FIR_12 * sizeof( opus_int16 ) );
  }
+<CODE ENDS>
 ]]></artwork>
 </figure>
-    <t>
-    Note: due to RFC formatting conventions, lines exceeding the column width
-    in the patch above are split using a backslash character. The backslashes
-    at the end of a line and the white space at the beginning
-    of the following line are not part of the patch. A properly formatted patch
-    including the three changes above is available at
-    <eref target="https://jmvalin.ca/misc_stuff/opus_update.patch"/>. (EDITOR:
-        change to an ietf.org link when ready)
-    </t>
     </section>
 
     <section title="Integer wrap-around in inverse gain computation">
@@ -229,11 +240,12 @@ RESAMPLER_ORDER_FIR_12 * sizeof( opus_int16 ) );
         It was discovered through decoder fuzzing that some bitstreams could produce
         integer values exceeding 32-bits in LPC_inverse_pred_gain_QA(), causing
         a wrap-around. Although the error is harmless in practice, the C standard considers
-        the behaviour as undefined, so the following patch detects values
-        that would cause wrap-around and considers the corresponding filters unstable:
+        the behavior as undefined, so the following patch to line 87 of silk/LPC_inv_pred_gain.c
+        detects values that do not fit in a 32-bit integer and considers the corresponding filters unstable:
       </t>
 <figure>
 <artwork><![CDATA[
+<CODE BEGINS>
          /* Update AR coefficient */
          for( n = 0; n < k; n++ ) {
 -            tmp_QA = Aold_QA[ n ] - MUL32_FRAC_Q( \
@@ -249,6 +261,7 @@ rc_mult2 ), mult2Q);
 +            }
 +            Anew_QA[ n ] = ( opus_int32 )tmp64;
          }
+<CODE ENDS>
 ]]></artwork>
 </figure>
     </section>
@@ -258,11 +271,12 @@ rc_mult2 ), mult2Q);
         It was discovered -- also from decoder fuzzing -- that an integer wrap-around could
         occur when decoding line spectral frequency coefficients from extreme bitstreams.
         The end result of the wrap-around is an illegal read access on the stack, which
-        the authors do not believe is explitable but should nontheless be fixed. The following
-        patch avoids the problem:
+        the authors do not believe is exploitable but should nonetheless be fixed. The following
+        patch to line 137 of silk/NLSF_stabilize.c prevents the problem:
       </t>
 <figure>
 <artwork><![CDATA[
+<CODE BEGINS>
            /* Keep delta_min distance between the NLSFs */
          for( i = 1; i < L; i++ )
 -            NLSF_Q15[i] = silk_max_int( NLSF_Q15[i], \
@@ -271,11 +285,34 @@ NLSF_Q15[i-1] + NDeltaMin_Q15[i] );
 silk_ADD_SAT16( NLSF_Q15[i-1], NDeltaMin_Q15[i] ) );
  
          /* Last NLSF should be no higher than 1 - NDeltaMin[L] */
+<CODE ENDS>
 ]]></artwork>
 </figure>
 
     </section>
 
+    <section title="Cap on Band Energy">
+      <t>On extreme bit-streams, it is possible for log-domain band energy levels
+        to exceed the maximum single-precision floating point value once converted
+        to a linear scale. This would later cause the decoded values to be NaN,
+        possibly causing problems in the software using the PCM values. This can be
+        avoided with the following patch to line 552 of celt/quant_bands.c:
+      </t>
+<figure>
+<artwork><![CDATA[
+<CODE BEGINS>
+       {
+          opus_val16 lg = ADD16(oldEBands[i+c*m->nbEBands],
+                          SHL16((opus_val16)eMeans[i],6));
++         lg = MIN32(QCONST32(32.f, 16), lg);
+          eBands[i+c*m->nbEBands] = PSHR32(celt_exp2(lg),4);
+       }
+       for (;i<m->nbEBands;i++)
+<CODE ENDS>
+]]></artwork>
+</figure>
+    </section>
+
     <section title="Hybrid Folding" anchor="folding">
       <t>When encoding in hybrid mode at low bitrate, we sometimes only have
         enough bits to code a single CELT band (8 - 9.6 kHz). When that happens,
@@ -285,7 +322,7 @@ silk_ADD_SAT16( NLSF_Q15[i-1], NDeltaMin_Q15[i] ) );
         can cause audible pre-echo.
       </t>
       <t>
-        To address the issue, we change the folding behaviour so that it is
+        To address the issue, we change the folding behavior so that it is
         never forced to fall back to LCG due to the first band not containing
         enough coefficients to fold onto the second band. This
         is achieved by simply repeating part of the first band in the folding
@@ -293,6 +330,7 @@ silk_ADD_SAT16( NLSF_Q15[i-1], NDeltaMin_Q15[i] ) );
       </t>
 <figure>
 <artwork><![CDATA[
+<CODE BEGINS>
           b = 0;
        }
  
@@ -321,6 +359,7 @@ n2-n1);
        tf_change = tf_res[i];
        if (i>=m->effEBands)
        {
+<CODE ENDS>
 ]]></artwork>
 </figure>
 
@@ -330,6 +369,7 @@ n2-n1);
 
 <figure>
 <artwork><![CDATA[
+<CODE BEGINS>
           fold_start = lowband_offset;
           while(M*eBands[--fold_start] > effective_lowband);
           fold_end = lowband_offset-1;
@@ -340,12 +380,13 @@ effective_lowband+N);
           fold_i = fold_start; do {
             x_cm |= collapse_masks[fold_i*C+0];
 
+<CODE ENDS>
 ]]></artwork>
 </figure>
       <t>
         The fix does not impact compatibility, because the improvement does
         not depend on the encoder doing anything special. There is also no
-        reasonable way for an encoder to use the original behaviour to
+        reasonable way for an encoder to use the original behavior to
         improve quality over the proposed change.
       </t>
     </section>
@@ -382,8 +423,13 @@ effective_lowband+N);
         SHOULD be based on the new test vectors rather than the old ones.
       </t>
       <t>The new test vectors are located at
-        <eref target="https://jmvalin.ca/misc_stuff/opus_newvectors.tar.gz"/>. (EDITOR:
-        change to an ietf.org link when ready)
+        <eref target="https://www.ietf.org/proceedings/98/slides/materials-98-codec-opus-newvectors-00.tar.gz"/>.
+      </t>
+    </section>
+
+    <section anchor="security" title="Security Considerations">
+      <t>This document adds no new security considerations on top of
+        <xref target="RFC6716">RFC 6716</xref>.
       </t>
     </section>
 
@@ -396,12 +442,13 @@ effective_lowband+N);
 
     <section anchor="Acknowledgements" title="Acknowledgements">
       <t>We would like to thank Juri Aedla for reporting the issue with the parsing of
-      the Opus padding.</t>
+      the Opus padding. Also, thanks to Jonathan Lennox and Mark Harris for their
+      feedback on this document.</t>
     </section>
   </middle>
 
   <back>
-    <references title="References">
+    <references title="Normative References">
       <?rfc include="http://xml.resource.org/public/rfc/bibxml/reference.RFC.2119.xml"?>
       <?rfc include="http://xml.resource.org/public/rfc/bibxml/reference.RFC.6716.xml"?>