Avoiding overflow in cross correlation in NetEq.

webrtc/modules/audio_coding/neteq/cross_correlation.cc

Index: webrtc/modules/audio_coding/neteq/cross_correlation.cc
diff --git a/webrtc/modules/audio_coding/neteq/cross_correlation.cc b/webrtc/modules/audio_coding/neteq/cross_correlation.cc
new file mode 100644
index 0000000000000000000000000000000000000000..89f4c150859d9491d1f00df92aae3c37f2ab5e77
--- /dev/null
+++ b/webrtc/modules/audio_coding/neteq/cross_correlation.cc
@@ -0,0 +1,67 @@
+/*
+ *  Copyright (c) 2016 The WebRTC project authors. All Rights Reserved.
+ *
+ *  Use of this source code is governed by a BSD-style license
+ *  that can be found in the LICENSE file in the root of the source
+ *  tree. An additional intellectual property rights grant can be found
+ *  in the file PATENTS.  All contributing project authors may
+ *  be found in the AUTHORS file in the root of the source tree.
+ */
+
+#include "webrtc/modules/audio_coding/neteq/cross_correlation.h"
+
+#include <assert.h>

[hlundin-webrtc, 2016/04/25 07:53:57]

Use DCHECK instead of assert, and include base/webrtc/checks.h instead of
assert.h.

[minyue-webrtc, 2016/04/27 10:38:03]

will remove

+#include <limits>

[hlundin-webrtc, 2016/04/25 07:53:57]

Order of includes is wrong.

[minyue-webrtc, 2016/04/27 10:38:03]

Done.

+#include <cmath>
+
+namespace webrtc {
+
+// This function decides the overflow-protecting scaling and calls
+// WebRtcSpl_CrossCorrelation.
+int CrossCorrelationWithAutoShift(int32_t* cross_correlation,
+                                  const int16_t* sequence_1,
+                                  const int16_t* sequence_2,
+                                  size_t sequence_1_length,
+                                  size_t cross_correlation_length,
+                                  int cross_correlation_step) {
+  // Find the maximum absolute value of sequence_1 and 2.
+  const int16_t max_1 = WebRtcSpl_MaxAbsValueW16(sequence_1, sequence_1_length);
+  const int sequence_2_shift =
+      cross_correlation_step * (cross_correlation_length - 1);
+  const int16_t* sequence_2_start =
+      sequence_2_shift >= 0 ? sequence_2 : sequence_2 + sequence_2_shift;
+  const size_t sequence_2_length =
+      sequence_1_length + std::abs(sequence_2_shift);
+  const int16_t max_2 =
+      WebRtcSpl_MaxAbsValueW16(sequence_2_start, sequence_2_length);
+
+  // In order to avoid overflow when computing the sum we should scale the
+  // samples so that (in_vector_length * max_1 * max_2) will not overflow.
+  // Expected scaling fulfills
+  // 1) sufficient:
+  //    sequence_1_length * (max_1 * max_2 >> scaling) <= 0x7fffffff;
+  // 2) necessary:
+  //    if (scaling > 0)
+  //      sequence_1_length * (max_1 * max_2 >> (scaling - 1)) > 0x7fffffff;
+  // The following calculation fulfills 1) and almost fulfills 2).
+  // There are some corner cases that 2) is not satisfied, e.g.,
+  // max_1 = 17, max_2 = 30848, sequence_1_length = 4095, in such case,
+  // optimal scaling is 0, while the following calculation results in 1.
+  const int32_t factor = (max_1 * max_2) / (std::numeric_limits<int32_t>::max()
+      / static_cast<int32_t>(sequence_1_length));
+  const int scaling = factor == 0 ? 0 : 31 - WebRtcSpl_NormW32(factor);
+
+  assert((double)max_1 * max_2 * sequence_1_length / (1 << scaling) <=

[hlundin-webrtc, 2016/04/25 07:53:57]

RTC_DCHECK_LE

[minyue-webrtc, 2016/04/27 10:38:03]

I plan to remove these two lines. I've done an exhaustive test on this two
lines.

+         std::numeric_limits<int32_t>::max());
+  assert(scaling == 0 ||

[hlundin-webrtc, 2016/04/25 07:53:57]

RTC_DCHECK

[minyue-webrtc, 2016/04/27 10:38:03]

also plan to remove

+      (double)max_1 * max_2 * sequence_1_length /(1 << scaling) * 2 >
+          std::numeric_limits<int32_t>::max());
+
+  WebRtcSpl_CrossCorrelation(cross_correlation, sequence_1, sequence_2,
+                             sequence_1_length, cross_correlation_length,
+                             scaling, cross_correlation_step);
+
+  return scaling;
+}
+
+}  // namespace webrtc