Conversational Speech tool, MultiEndCall class and unit tests via mocking

webrtc/modules/audio_processing/test/conversational_speech/wavreader_interface.h

Index: webrtc/modules/audio_processing/test/conversational_speech/wavreader_interface.h
diff --git a/webrtc/modules/audio_processing/test/conversational_speech/wavreader_interface.h b/webrtc/modules/audio_processing/test/conversational_speech/wavreader_interface.h
new file mode 100644
index 0000000000000000000000000000000000000000..02c56285913dc59ac694bc16647893103fea7e08
--- /dev/null
+++ b/webrtc/modules/audio_processing/test/conversational_speech/wavreader_interface.h
@@ -0,0 +1,39 @@
+/*
+ *  Copyright (c) 2017 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.
+ */
+
+#ifndef WEBRTC_MODULES_AUDIO_PROCESSING_TEST_CONVERSATIONAL_SPEECH_WAVREADER_INTERFACE_H_
+#define WEBRTC_MODULES_AUDIO_PROCESSING_TEST_CONVERSATIONAL_SPEECH_WAVREADER_INTERFACE_H_
+
+#include <stdint.h>

[hlundin-webrtc, 2017/03/24 13:44:11]

#include "webrtc/typedefs.h"

[AleBzk, 2017/03/27 08:24:14]

Done.

+#include <cstddef>
+
+namespace webrtc {
+namespace test {
+namespace conversational_speech {
+
+class WavReaderInterface {

[AleBzk, 2017/03/23 15:07:14]

This is the interface of what is created by a concrete WavReader factory through
the Create() method.
The factory is injected into MultiEndCall instances.

+ public:
+  virtual ~WavReaderInterface() {}

[hlundin-webrtc, 2017/03/24 13:44:13]

= default;

[AleBzk, 2017/03/27 08:24:14]

Done.

+
+  // Returns the number of samples read. If this is less than requested,
+  // verifies that the end of the file was reached.

[hlundin-webrtc, 2017/03/24 13:44:11]

"verifies that the end of the file was reached"
This seems to be an implementation details which does not belong in the
interface. What does it mean to the user if less than requested number of
samples were read?

[AleBzk, 2017/03/27 08:24:14]

Right. I stole the docstring from
https://cs.chromium.org/chromium/src/third_party/webrtc/common_audio/wav_file...
which in fact is for a concrete class.

+  virtual size_t ReadSamples(size_t num_samples, float* samples) = 0;

[hlundin-webrtc, 2017/03/24 13:44:13]

The style guide recommends that you create two different names instead of
overloading. E.g.,
ReadFloatSamples
ReadInt16Samples

https://google.github.io/styleguide/cppguide.html#Function_Overloading

[AleBzk, 2017/03/27 08:24:14]

Done.

+  virtual size_t ReadSamples(size_t num_samples, int16_t* samples) = 0;
+
+  virtual int sample_rate() const = 0;

[hlundin-webrtc, 2017/03/24 13:44:10]

Since this is an interface, and there is no implementation to read, you may want
to document these methods better. Also, the underscore_naming is reserved for
accessors and mutators (or functions that are very light-weight, similar to an
accessor or mutator), but you don't know that what implementation of this
interface will look like. It might not even have member variables with these
names.

[AleBzk, 2017/03/27 08:24:14]

True. But I wanted to provide the same interface as done in
https://cs.chromium.org/chromium/src/third_party/webrtc/common_audio/wav_file....

For now, I keep it as it is. Just let me know if you prefer that I switch to
CapWords.

[hlundin-webrtc, 2017/03/27 09:46:35]

I see. This is fine.

+  virtual size_t num_channels() const = 0;
+  virtual size_t num_samples() const = 0;
+};
+
+}  // namespace conversational_speech
+}  // namespace test
+}  // namespace webrtc
+
+#endif  // WEBRTC_MODULES_AUDIO_PROCESSING_TEST_CONVERSATIONAL_SPEECH_WAVREADER_INTERFACE_H_