Fix a bug in AudioRendererHost and add hooks for test

chrome/browser/renderer_host/audio_renderer_host.h

-// Copyright (c) 2006-2009 The Chromium Authors. All rights reserved.
+// Copyright (c) 2009 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.
 //
 // AudioRendererHost serves audio related requests from AudioRenderer which
 // lives inside the render process and provide access to audio hardware. It maps
 // an internal ID to AudioRendererHost::IPCAudioSource in a map, which is the
 // actual object providing audio packets through IPC. It creates the actual
 // AudioOutputStream object when requested by the renderer provided with
 // render view id and stream id.
 //
@@ skipping 59 matching lines @@
 #include <deque>
 
 #include "base/lock.h"
 #include "base/process.h"
 #include "base/ref_counted.h"
 #include "base/shared_memory.h"
 #include "base/waitable_event.h"
 #include "chrome/common/ipc_message.h"
 #include "media/audio/audio_output.h"
 #include "media/audio/simple_sources.h"
+#include "testing/gtest/include/gtest/gtest_prod.h"
 
 class AudioManager;
 class MessageLoop;
 struct ViewHostMsg_Audio_CreateStream;
 
 class AudioRendererHost : public base::RefCountedThreadSafe<AudioRendererHost> {
  private:
   class IPCAudioSource;
-  friend class AudioRendererHost::IPCAudioSource;
  public:
   // Called from UI thread from the owner of this object.
   explicit AudioRendererHost(MessageLoop* message_loop);
 
   // Destruction can happen on either UI thread or IO thread, but at destruction
   // all associated sources are destroyed and streams are closed.
   ~AudioRendererHost();
 
   // Called from UI thread from the owner of this object to kick start
   // destruction of streams in IO thread.
   void Destroy();
 
   //---------------------------------------------------------------------------
   // The following public methods are called from ResourceMessageFilter in the
   // IO thread.
 
   // Event received when IPC channel is connected with the renderer process.
   void IPCChannelConnected(int process_id, base::ProcessHandle process_handle,
                            IPC::Message::Sender* ipc_sender);
 
   // Event received when IPC channel is closing.
   void IPCChannelClosing();
 
   // Returns true if the message is a audio related message and was processed.
   // If it was, message_was_ok will be false iff the message was corrupt.
   bool OnMessageReceived(const IPC::Message& message, bool* message_was_ok);
 
- private:
-  //---------------------------------------------------------------------------
-  // Methods called on IO thread.
-  // Returns true if the message is an audio related message and should be
-  // handled by this class.
-  bool IsAudioRendererHostMessage(const IPC::Message& message);
-
-  // Audio related IPC message handlers.
-  // Creates an audio output stream with the specified format. If this call is
-  // successful this object would keep an internal entry of the stream for the
-  // required properties. See IPCAudioSource::CreateIPCAudioSource for more
-  // details.
-  void OnCreateStream(const IPC::Message& msg, int stream_id,
-                      const ViewHostMsg_Audio_CreateStream& params);
-
-  // Starts buffering for the audio output stream. Delegates the start method
-  // call to the corresponding IPCAudioSource::Start.
-  // ViewMsg_NotifyAudioStreamStateChanged with
-  // AudioOutputStream::AUDIO_STREAM_ERROR is sent back to renderer if the
-  // required IPCAudioSource is not found.
-  void OnStartStream(const IPC::Message& msg, int stream_id);
-
-  // Pauses the audio output stream. Delegates the pause method call to the
-  // corresponding IPCAudioSource::Pause, ViewMsg_NotifyAudioStreamStateChanged
-  // with AudioOutputStream::AUDIO_STREAM_ERROR is sent back to renderer if the
-  // required IPCAudioSource is not found.
-  void OnPauseStream(const IPC::Message& msg, int stream_id);
-
-  // Closes the audio output stream, delegates the close method call to the
-  // corresponding IPCAudioSource::Close, no returning IPC message to renderer
-  // upon success and failure.
-  void OnCloseStream(const IPC::Message& msg, int stream_id);
-
-  // Set the volume for the stream specified. Delegates the SetVolume method
-  // call to IPCAudioSource. No returning IPC message to renderer upon success.
-  // ViewMsg_NotifyAudioStreamStateChanged with
-  // AudioOutputStream::AUDIO_STREAM_ERROR is sent back to renderer if the
-  // required IPCAudioSource is not found.
-  void OnSetVolume(const IPC::Message& msg, int stream_id,
-                   double left_channel, double right_channel);
-
-  // Gets the volume of the stream specified, delegates to corresponding
-  // IPCAudioSource::GetVolume, see the method for more details.
-  // ViewMsg_NotifyAudioStreamStateChanged with
-  // AudioOutputStream::AUDIO_STREAM_ERROR is sent back to renderer if the
-  // required IPCAudioSource is not found.
-  void OnGetVolume(const IPC::Message& msg, int stream_id);
-
-  // Notify packet has been prepared for stream, delegates to corresponding
-  // IPCAudioSource::NotifyPacketReady, see the method for more details.
-  // ViewMsg_NotifyAudioStreamStateChanged with
-  // AudioOutputStream::AUDIO_STREAM_ERROR is sent back to renderer if the
-  // required IPCAudioSource is not found.
-  void OnNotifyPacketReady(const IPC::Message& msg, int stream_id,
-                           size_t packet_size);
-
-  // Called on IO thread when this object is created and initialized.
-  void OnInitialized();
-
-  // Called on IO thread when this object needs to be destroyed and after
-  // Destroy() is called from owner of this class in UI thread.
-  void OnDestroyed();
-
-  // Sends IPC messages using ipc_sender_.
-  void OnSend(IPC::Message* message);
-
-  // Closes the source, deletes it and removes it from the internal map.
-  // Destruction of source and associated stream should always be done by this
-  // method. *DO NOT* call this method from other than IPCAudioSource and from
-  // this class.
-  void OnDestroySource(IPCAudioSource* source);
-
-  // A helper method that destroy all IPCAudioSource and associated audio
-  // output streams.
-  void DestroyAllSources();
-
-  // A helper method to look up a IPCAudioSource with a tuple of render view id
-  // and stream id. Returns NULL if not found.
-  IPCAudioSource* Lookup(int render_view_id, int stream_id);
-
+ protected:
   //---------------------------------------------------------------------------
   // Helper methods called from IPCAudioSource or from this class, since
   // methods in IPCAudioSource maybe called from hardware audio threads, these
   // methods make sure the actual tasks happen on IO thread.
+  // These methods are virtual protected so we can mock these methods to test
+  // IPCAudioSource.
 
   // A helper method to send an IPC message to renderer process on IO thread.
-  void Send(IPC::Message* message);
+  virtual void Send(IPC::Message* message);
 
   // A helper method for sending error IPC messages.
-  void SendErrorMessage(int32 render_view_id, int32 stream_id, int info);
+  virtual void SendErrorMessage(int32 render_view_id,
+                                int32 stream_id,
+                                int info);
 
   // A helper method for calling OnDestroySource on IO thread.
-  void DestroySource(IPCAudioSource* source);
+  virtual void DestroySource(IPCAudioSource* source);
 
-  MessageLoop* io_loop() { return io_loop_; }
+ private:
+  friend class AudioRendererHost::IPCAudioSource;
+  friend class AudioRendererHostTest;
+  FRIEND_TEST(AudioRendererHostTest, CreateMockStream);
+  FRIEND_TEST(AudioRendererHostTest, MockStreamDataConversation);
 
   // The container for AudioOutputStream and serves the audio packet received
   // via IPC.
   class IPCAudioSource : public AudioOutputStream::AudioSourceCallback {
    public:
     // Factory method for creating an IPCAudioSource, returns NULL if failed.
     // The IPCAudioSource object will have an internal state of
     // AudioOutputStream::STATE_CREATED after creation.
     // If an IPCAudioSource is created successfully, a
     // ViewMsg_NotifyAudioStreamCreated message is sent to the renderer.
@@ skipping 96 matching lines @@
     // Number of bytes copied in the last OnMoreData call.
     size_t last_copied_bytes_;
 
     // Protects:
     // - |outstanding_requests_|
     // - |last_copied_bytes_|
     // - |push_source_|
     Lock lock_;
   };
 
+  //---------------------------------------------------------------------------
+  // Methods called on IO thread.
+  // Returns true if the message is an audio related message and should be
+  // handled by this class.
+  bool IsAudioRendererHostMessage(const IPC::Message& message);
+
+  // Audio related IPC message handlers.
+  // Creates an audio output stream with the specified format. If this call is
+  // successful this object would keep an internal entry of the stream for the
+  // required properties. See IPCAudioSource::CreateIPCAudioSource() for more
+  // details.
+  void OnCreateStream(const IPC::Message& msg, int stream_id,
+                      const ViewHostMsg_Audio_CreateStream& params);
+
+  // Starts buffering for the audio output stream. Delegates the start method
+  // call to the corresponding IPCAudioSource::Start().
+  // ViewMsg_NotifyAudioStreamStateChanged with
+  // AudioOutputStream::AUDIO_STREAM_ERROR is sent back to renderer if the
+  // required IPCAudioSource is not found.
+  void OnStartStream(const IPC::Message& msg, int stream_id);
+
+  // Pauses the audio output stream. Delegates the pause method call to the
+  // corresponding IPCAudioSource::Pause(),
+  // ViewMsg_NotifyAudioStreamStateChanged with
+  // AudioOutputStream::AUDIO_STREAM_ERROR is sent back to renderer if the
+  // required IPCAudioSource is not found.
+  void OnPauseStream(const IPC::Message& msg, int stream_id);
+
+  // Closes the audio output stream, delegates the close method call to the
+  // corresponding IPCAudioSource::Close(), no returning IPC message to renderer
+  // upon success and failure.
+  void OnCloseStream(const IPC::Message& msg, int stream_id);
+
+  // Set the volume for the stream specified. Delegates the SetVolume() method
+  // call to IPCAudioSource. No returning IPC message to renderer upon success.
+  // ViewMsg_NotifyAudioStreamStateChanged with
+  // AudioOutputStream::AUDIO_STREAM_ERROR is sent back to renderer if the
+  // required IPCAudioSource is not found.
+  void OnSetVolume(const IPC::Message& msg, int stream_id,
+                   double left_channel, double right_channel);
+
+  // Gets the volume of the stream specified, delegates to corresponding
+  // IPCAudioSource::GetVolume(), see the method for more details.
+  // ViewMsg_NotifyAudioStreamStateChanged with
+  // AudioOutputStream::AUDIO_STREAM_ERROR is sent back to renderer if the
+  // required IPCAudioSource is not found.
+  void OnGetVolume(const IPC::Message& msg, int stream_id);
+
+  // Notify packet has been prepared for stream, delegates to corresponding
+  // IPCAudioSource::NotifyPacketReady(), see the method for more details.
+  // ViewMsg_NotifyAudioStreamStateChanged with
+  // AudioOutputStream::AUDIO_STREAM_ERROR is sent back to renderer if the
+  // required IPCAudioSource is not found.
+  void OnNotifyPacketReady(const IPC::Message& msg, int stream_id,
+                           size_t packet_size);
+
+  // Called on IO thread when this object is created and initialized.
+  void OnInitialized();
+
+  // Called on IO thread when this object needs to be destroyed and after
+  // Destroy() is called from owner of this class in UI thread.
+  void OnDestroyed();
+
+  // Sends IPC messages using ipc_sender_.
+  void OnSend(IPC::Message* message);
+
+  // Closes the source, deletes it and removes it from the internal map.
+  // Destruction of source and associated stream should always be done by this
+  // method. *DO NOT* call this method from other than IPCAudioSource and from
+  // this class.
+  void OnDestroySource(IPCAudioSource* source);
+
+  // A helper method that destroy all IPCAudioSource and associated audio
+  // output streams.
+  void DestroyAllSources();
+
+  // A helper method to look up a IPCAudioSource with a tuple of render view id
+  // and stream id. Returns NULL if not found.
+  IPCAudioSource* Lookup(int render_view_id, int stream_id);
+
+  MessageLoop* io_loop() { return io_loop_; }
+
   int process_id_;
   base::ProcessHandle process_handle_;
   IPC::Message::Sender* ipc_sender_;
 
   // A map of id to audio sources.
   typedef std::pair<int32, int32> SourceID;
   typedef std::map<SourceID, IPCAudioSource*> SourceMap;
   SourceMap sources_;
 
   MessageLoop* io_loop_;
 
   DISALLOW_COPY_AND_ASSIGN(AudioRendererHost);
 };
 
 #endif  // CHROME_BROWSER_RENDERER_HOST_AUDIO_RENDERER_HOST_H_