Binding media stream audio track to speech recognition [renderer]

content/renderer/speech_recognition_dispatcher.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_SPEECH_RECOGNITION_DISPATCHER_H_
 #define CONTENT_RENDERER_SPEECH_RECOGNITION_DISPATCHER_H_
 
 #include <map>
 
 #include "base/basictypes.h"
+#include "base/memory/shared_memory.h"
+#include "base/sync_socket.h"
 #include "content/public/common/speech_recognition_result.h"
 #include "content/public/renderer/render_view_observer.h"
+#include "third_party/WebKit/public/platform/WebMediaStreamTrack.h"
 #include "third_party/WebKit/public/platform/WebVector.h"
 #include "third_party/WebKit/public/web/WebSpeechRecognitionHandle.h"
 #include "third_party/WebKit/public/web/WebSpeechRecognizer.h"
 
+namespace media {
+class AudioParameters;
+}
+
 namespace content {
 class RenderViewImpl;
+class SpeechRecognitionAudioSourceProvider;
 struct SpeechRecognitionError;
 struct SpeechRecognitionResult;
 
 // SpeechRecognitionDispatcher is a delegate for methods used by WebKit for
 // scripted JS speech APIs. It's the complement of
 // SpeechRecognitionDispatcherHost (owned by RenderViewHost).
 class SpeechRecognitionDispatcher : public RenderViewObserver,
                                     public blink::WebSpeechRecognizer {
  public:
   explicit SpeechRecognitionDispatcher(RenderViewImpl* render_view);
@@ skipping 17 matching lines @@
 
   void OnRecognitionStarted(int request_id);
   void OnAudioStarted(int request_id);
   void OnSoundStarted(int request_id);
   void OnSoundEnded(int request_id);
   void OnAudioEnded(int request_id);
   void OnErrorOccurred(int request_id, const SpeechRecognitionError& error);
   void OnRecognitionEnded(int request_id);
   void OnResultsRetrieved(int request_id,
                           const SpeechRecognitionResults& result);
+  // Called by IPC.

[jamesr, 2014/09/23 23:31:39]

this comment is not helpful.  All of the On...() functions are IPC handlers,
that naming convention is enough

[burnik, 2014/09/24 09:04:37]

Done.

+  void OnAudioTrackReady(int session_id, const media::AudioParameters& params,
+                         base::SharedMemoryHandle handle,
+                         base::SyncSocket::TransitDescriptor socket);
+  // Called By |audio_source_provider_|.

[jamesr, 2014/09/23 23:31:39]

not a very useful comment either and not really true, since we're doing the bind
call audio_source_provider_ doesn't link against this.

You should give this a different name (so it doesn't look like an IPC handler)
and put a blank line between this and the ipc handlers

[burnik, 2014/09/24 09:04:37]

How does this sound?

  // Callback for SpeechRecognitionAudioSourceProvider::OnStoppedCB.
  void AudioTrackStopped();

+  void OnAudioTrackStopped();
 
   int GetOrCreateIDForHandle(const blink::WebSpeechRecognitionHandle& handle);
   bool HandleExists(const blink::WebSpeechRecognitionHandle& handle);
   const blink::WebSpeechRecognitionHandle& GetHandleFromID(int handle_id);
 
   // The WebKit client class that we use to send events back to the JS world.
   blink::WebSpeechRecognizerClient* recognizer_client_;
 
+  // Media stream audio track that the speech recognition connects to.
+  // Accessed on the render thread.
+  blink::WebMediaStreamTrack audio_track_;
+
+  // Audio sink used to provide audio from the track.
+  scoped_ptr<SpeechRecognitionAudioSourceProvider> audio_source_provider_;
+
   typedef std::map<int, blink::WebSpeechRecognitionHandle> HandleMap;
   HandleMap handle_map_;
   int next_id_;
 
   DISALLOW_COPY_AND_ASSIGN(SpeechRecognitionDispatcher);
 };
 
 }  // namespace content
 
 #endif  // CONTENT_RENDERER_SPEECH_RECOGNITION_DISPATCHER_H_