Implements RTP header dumping.

chrome/browser/media/webrtc_logging_handler_host.h

 // Copyright 2013 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 #ifndef CHROME_BROWSER_MEDIA_WEBRTC_LOGGING_HANDLER_HOST_H_
 #define CHROME_BROWSER_MEDIA_WEBRTC_LOGGING_HANDLER_HOST_H_
 
 #include "base/basictypes.h"
 #include "base/memory/shared_memory.h"
+#include "chrome/browser/media/webrtc_rtp_dump_handler.h"
 #include "chrome/common/media/webrtc_logging_message_data.h"
 #include "content/public/browser/browser_message_filter.h"
 #include "net/base/net_util.h"
 
 namespace net {
 class URLRequestContextGetter;
 }  // namespace net
 
 class PartialCircularBuffer;
 class Profile;
@@ skipping 24 matching lines @@
   void SetMetaData(const MetaDataMap& meta_data,
                    const GenericDoneCallback& callback);
 
   // Opens a log and starts logging. Must be called on the IO thread.
   void StartLogging(const GenericDoneCallback& callback);
 
   // Stops logging. Log will remain open until UploadLog or DiscardLog is
   // called. Must be called on the IO thread.
   void StopLogging(const GenericDoneCallback& callback);
 
-  // Uploads the log and discards the local copy. May only be called after
-  // logging has stopped. Must be called on the IO thread.
+  // Uploads the log and the RTP dumps. Discards the local copy. May only be
+  // called after logging has stopped. Must be called on the IO thread.
   void UploadLog(const UploadDoneCallback& callback);
 
   // Called by WebRtcLogUploader when uploading has finished. Must be called on
   // the IO thread.
   void UploadLogDone();
 
-  // Discards the log. May only be called after logging has stopped. Must be
-  // called on the IO thread.
+  // Discards the log and the RTP dumps. May only be called after logging has
+  // stopped. Must be called on the IO thread.
   void DiscardLog(const GenericDoneCallback& callback);
 
   // Adds a message to the log.
   void LogMessage(const std::string& message);
 
   // May be called on any thread. |upload_log_on_render_close_| is used
   // for decision making and it's OK if it changes before the execution based
   // on that decision has finished.
   void set_upload_log_on_render_close(bool should_upload) {
     upload_log_on_render_close_ = should_upload;
   }
 
   // Starts dumping the RTP headers for the specified direction. Must be called
   // on the IO thread. |incoming| and |outgoing| specifies which direction(s) of
   // RTP packets should be dumped. |callback| will be called when starting the
   // dump is done.
   void StartRtpDump(bool incoming,
                     bool outgoing,
                     const GenericDoneCallback& callback);
 
   // Stops dumping the RTP headers for the specified direction. Must be called
   // on the IO thread. |incoming| and |outgoing| specifies which direction(s) of
   // RTP packet dumping should be stopped. |callback| will be called when
   // stopping the dump is done.
   void StopRtpDump(bool incoming,
                    bool outgoing,
                    const GenericDoneCallback& callback);
 
+  // Called when a RTP packet is sent or received. Can be called on any thread.

[Henrik Grunell, 2014/05/13 09:12:31]

Nit: an RTP packet.

[jiayl, 2014/05/13 21:48:17]

Done.

+  void OnRtpPacket(const uint8* packet_header,
+                   size_t header_length,
+                   size_t packet_length,
+                   bool incoming);
+
  private:
   // States used for protecting from function calls made at non-allowed points
   // in time. For example, StartLogging() is only allowed in CLOSED state.
   // Transitions: SetMetaData(): CLOSED -> CLOSED.
   //              StartLogging(): CLOSED -> STARTING.
   //              Start done: STARTING -> STARTED.
   //              StopLogging(): STARTED -> STOPPING.
   //              Stop done: STOPPING -> STOPPED.
   //              UploadLog(): STOPPED -> UPLOADING.
   //              Upload done: UPLOADING -> CLOSED.
@@ skipping 31 matching lines @@
   void LogInitialInfoOnIOThread(const net::NetworkInterfaceList& network_list);
   void NotifyLoggingStarted();
 
   // Writes a formatted log |message| to the |circular_buffer_|.
   void LogToCircularBuffer(const std::string& message);
 
   // Gets the log directory path for |profile_| and ensure it exists. Must be
   // called on the FILE thread.
   base::FilePath GetLogDirectoryAndEnsureExists();
 
-  void TriggerUploadLog(const base::FilePath& log_directory);
+  void TriggerUploadLogAndRtpDump(const base::FilePath& log_directory);

[Henrik Grunell, 2014/05/13 09:12:31]

Maybe just TriggerUpload?

[jiayl, 2014/05/13 21:48:17]

Done.

 
   void FireGenericDoneCallback(GenericDoneCallback* callback,
                                bool success,
                                const std::string& error_message);
 
+  void CreateRtpDumpHandlerAndStart(bool incoming,

[Henrik Grunell, 2014/05/13 09:12:31]

I think comments on all added functions are good.

[jiayl, 2014/05/13 21:48:17]

Done.

+                                    bool outgoing,
+                                    GenericDoneCallback callback,
+                                    const base::FilePath& dump_dir);
+
+  void DoUpload(const base::FilePath& log_directory,

[Henrik Grunell, 2014/05/13 09:12:31]

What will this upload? Can the name be changed to clarify what it does?

[jiayl, 2014/05/13 21:48:17]

Done.

+                const WebRtcRtpDumpHandler::ReleasedDumps& rtp_dumps);
+
+  void DumpRtpPacketOnIOThread(scoped_ptr<uint8[]> packet_header,
+                               size_t header_length,
+                               size_t packet_length,
+                               bool incoming);
+
   scoped_ptr<unsigned char[]> log_buffer_;
   scoped_ptr<PartialCircularBuffer> circular_buffer_;
 
   // The profile associated with our renderer process.
   Profile* profile_;
 
   // These are only accessed on the IO thread, except when in STARTING state. In
   // this state we are protected since entering any function that alters the
   // state is not allowed.
   MetaDataMap meta_data_;
@@ skipping 14 matching lines @@
 
   // This is the handle to be passed to the render process. It's stored so that
   // it doesn't have to be passed on when posting messages between threads.
   // It's only accessed on the IO thread.
   base::SharedMemoryHandle foreign_memory_handle_;
 
   // The system time in ms when logging is started. Reset when logging_state_
   // changes to STOPPED.
   base::Time logging_started_time_;
 
+  scoped_ptr<WebRtcRtpDumpHandler> rtp_dump_handler_;

[Henrik Grunell, 2014/05/13 09:12:31]

Add comment.

[jiayl, 2014/05/13 21:48:17]

Done.

+
   DISALLOW_COPY_AND_ASSIGN(WebRtcLoggingHandlerHost);
 };
 
 #endif  // CHROME_BROWSER_MEDIA_WEBRTC_LOGGING_HANDLER_HOST_H_