Adding debug dump to audio network adaptor.

webrtc/modules/audio_coding/audio_network_adaptor/debug_dump_writer.h

+/*
+ *  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.
+ */
+
+#ifndef WEBRTC_MODULES_AUDIO_CODING_AUDIO_NETWORK_ADAPTOR_DEBUG_DUMP_WRITER_H_
+#define WEBRTC_MODULES_AUDIO_CODING_AUDIO_NETWORK_ADAPTOR_DEBUG_DUMP_WRITER_H_
+
+#include <memory>
+#include <string>
+
+#include "webrtc/base/constructormagic.h"
+#include "webrtc/modules/audio_coding/audio_network_adaptor/controller.h"
+#include "webrtc/modules/audio_coding/audio_network_adaptor/include/audio_network_adaptor.h"
+#include "webrtc/system_wrappers/include/file_wrapper.h"
+
+namespace webrtc {
+
+class DebugDumpWriter {
+ public:
+  virtual ~DebugDumpWriter() = default;
+
+  virtual void DumpEncoderRuntimeConfig(
+      const AudioNetworkAdaptor::EncoderRuntimeConfig& config,
+      int64_t timestamp) = 0;
+
+  virtual void DumpNetworkMetrics(const Controller::NetworkMetrics& metrics,
+                                  int64_t timestamp) = 0;
+};

[kwiberg-webrtc, 2016/09/21 10:54:09]

Excellent with an interface class that's *just* an interface, and a separate
class for the implementation.

[minyue-webrtc, 2016/09/22 15:11:49]

:)

+
+class DebugDumpWriterImpl final : public DebugDumpWriter {
+ public:
+  explicit DebugDumpWriterImpl(std::string dump_file_name);
+  explicit DebugDumpWriterImpl(FILE* file_handle);
+  ~DebugDumpWriterImpl() override;
+
+  void DumpEncoderRuntimeConfig(
+      const AudioNetworkAdaptor::EncoderRuntimeConfig& config,
+      int64_t timestamp) override;
+
+  void DumpNetworkMetrics(const Controller::NetworkMetrics& metrics,
+                          int64_t timestamp) override;
+
+ private:
+  std::unique_ptr<FileWrapper> dump_file_;
+
+  RTC_DISALLOW_COPY_AND_ASSIGN(DebugDumpWriterImpl);
+};

[kwiberg-webrtc, 2016/09/21 10:54:09]

Unless you have a specific reason for wanting to expose the Impl class, I
suggest moving it to the .cc file, and exposing only a Create function here.
That makes the code easier to read, because you know right away that the Impl
class communicates with the rest of the world *only* through the DebugDumpWriter
interface.

[minyue-webrtc, 2016/09/22 15:11:49]

Done.

+
+}  // namespace webrtc
+
+#endif  // WEBRTC_MODULES_AUDIO_CODING_AUDIO_NETWORK_ADAPTOR_DEBUG_DUMP_WRITER_H_