PepperPlatformAudioInputImpl: support audio input device selection.

content/renderer/pepper/pepper_platform_audio_input_impl.h

 // Copyright (c) 2012 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 CONTENT_RENDERER_PEPPER_PEPPER_PLATFORM_AUDIO_INPUT_IMPL_H_
 #define CONTENT_RENDERER_PEPPER_PEPPER_PLATFORM_AUDIO_INPUT_IMPL_H_
 
+#include <string>
+
 #include "base/basictypes.h"
 #include "base/memory/ref_counted.h"
 #include "base/memory/scoped_ptr.h"
+#include "base/memory/weak_ptr.h"
 #include "content/renderer/media/audio_input_message_filter.h"
+#include "media/audio/audio_parameters.h"
 #include "webkit/plugins/ppapi/plugin_delegate.h"
 
+class PepperPluginDelegateImpl;

[viettrungluu, 2012/03/16 22:29:09]

Alphabetical order?

[yzshen1, 2012/03/17 09:32:56]

I thought 'class' should be prior to 'struct'.

On 2012/03/16 22:29:09, viettrungluu wrote:

[viettrungluu, 2012/03/17 23:52:22]

Most places I've seen alphabetize based on the name, ignoring "class" or
"struct". <shrug>

On 2012/03/17 09:32:56, yzshen1 wrote:

[yzshen1, 2012/03/19 21:47:54]

Done.

 struct AudioParameters;
 
 class PepperPlatformAudioInputImpl
     : public webkit::ppapi::PluginDelegate::PlatformAudioInput,
       public AudioInputMessageFilter::Delegate,
       public base::RefCountedThreadSafe<PepperPlatformAudioInputImpl> {
  public:
   virtual ~PepperPlatformAudioInputImpl();
 
   // Factory function, returns NULL on failure. StreamCreated() will be called
   // when the stream is created.
   static PepperPlatformAudioInputImpl* Create(
+      const base::WeakPtr<PepperPluginDelegateImpl>& plugin_delegate,
+      const std::string& device_id,
       uint32_t sample_rate,
       uint32_t sample_count,
-      webkit::ppapi::PluginDelegate::PlatformAudioCommonClient* client);
+      webkit::ppapi::PluginDelegate::PlatformAudioInputClient* client);
 
   // PlatformAudioInput implementation (called on main thread).
   virtual bool StartCapture() OVERRIDE;
   virtual bool StopCapture() OVERRIDE;
   virtual void ShutDown() OVERRIDE;
 
  private:
   PepperPlatformAudioInputImpl();
 
   bool Initialize(
+      const base::WeakPtr<PepperPluginDelegateImpl>& plugin_delegate,
+      const std::string& device_id,
       uint32_t sample_rate,
       uint32_t sample_count,
-      webkit::ppapi::PluginDelegate::PlatformAudioCommonClient* client);
+      webkit::ppapi::PluginDelegate::PlatformAudioInputClient* client);
 
   // I/O thread backends to above functions.
-  void InitializeOnIOThread(const AudioParameters& params);
+  void InitializeOnIOThread(int session_id);
   void StartCaptureOnIOThread();
   void StopCaptureOnIOThread();
   void ShutDownOnIOThread();
 
   // AudioInputMessageFilter::Delegate.
   virtual void OnStreamCreated(base::SharedMemoryHandle handle,
                                base::SyncSocket::Handle socket_handle,
                                uint32 length) OVERRIDE;
   virtual void OnVolume(double volume) OVERRIDE;
   virtual void OnStateChanged(AudioStreamState state) OVERRIDE;
   virtual void OnDeviceReady(const std::string&) OVERRIDE;
 
+  void OnDeviceOpened(int request_id,
+                      bool succeeded,
+                      const std::string& label);
+  void CloseDevice();
+  void NotifyStreamCreationFailed();
+
   // The client to notify when the stream is created. THIS MUST ONLY BE
   // ACCESSED ON THE MAIN THREAD.
-  webkit::ppapi::PluginDelegate::PlatformAudioCommonClient* client_;
+  webkit::ppapi::PluginDelegate::PlatformAudioInputClient* client_;
 
   // MessageFilter used to send/receive IPC. THIS MUST ONLY BE ACCESSED ON THE
   // I/O thread except to send messages and get the message loop.
   scoped_refptr<AudioInputMessageFilter> filter_;
 
   // Our ID on the MessageFilter. THIS MUST ONLY BE ACCESSED ON THE I/O THREAD
   // or else you could race with the initialize function which sets it.
   int32 stream_id_;
 
   base::MessageLoopProxy* main_message_loop_proxy_;
 
+  // THIS MUST ONLY BE ACCESSED ON THE MAIN THREAD.

[viettrungluu, 2012/03/16 22:29:09]

Is the thread usage of this class documented somewhere?

Also, it might be helpful to implement appropriate getters/setters that DCHECK()
the thread.

[yzshen1, 2012/03/19 21:47:54]

Done. I added a threading comment for this class at the top.
Adding getters/setters bloats the class definition a little bit. Since all these
data members are private and they are clearly commented, I think it is okay to
not use getters/setters.
(Besides, all methods are DCHECKed to make sure they are used on the right
thread.)

What do you think?

[viettrungluu, 2012/03/20 18:20:02]

Sounds fine, now that you've clarified the thread semantics.

+  base::WeakPtr<PepperPluginDelegateImpl> plugin_delegate_;
+
+  // The label of the opened device. THIS MUST ONLY BE ACCESSED ON THE MAIN

[viettrungluu, 2012/03/16 22:29:09]

What exactly is a "label"? (The human-readable name? In what encoding?)

[yzshen1, 2012/03/19 21:47:54]

This is a unique ID generated by the media code to identify a request.
http://code.google.com/codesearch#OAMlx_jo-ck/src/content/browser/renderer_ho...

On 2012/03/16 22:29:09, viettrungluu wrote:

+  // THREAD.
+  std::string label_;
+
+  // Whether ShutDownOnIOThread() has been called. THIS MUST ONLY BE ACCESSED ON
+  // THE I/O THREAD.
+  bool shutdown_called_;
+
+  // Initialized on the main thread and accessed on the I/O thread afterwards.
+  AudioParameters params_;
+
   DISALLOW_COPY_AND_ASSIGN(PepperPlatformAudioInputImpl);
 };
 
 #endif  // CONTENT_RENDERER_PEPPER_PEPPER_PLATFORM_AUDIO_INPUT_IMPL_H_