Binding media stream audio track to speech recognition [renderer]

content/renderer/speech_recognition_dispatcher.cc

 // 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.
 
 #include "content/renderer/speech_recognition_dispatcher.h"
 
 #include "base/basictypes.h"
 #include "base/strings/utf_string_conversions.h"
 #include "content/common/speech_recognition_messages.h"
+#include "content/renderer/media/speech_recognition_audio_sink.h"
 #include "content/renderer/render_view_impl.h"
 #include "third_party/WebKit/public/platform/WebString.h"
 #include "third_party/WebKit/public/platform/WebVector.h"
 #include "third_party/WebKit/public/web/WebSpeechGrammar.h"
 #include "third_party/WebKit/public/web/WebSpeechRecognitionParams.h"
 #include "third_party/WebKit/public/web/WebSpeechRecognitionResult.h"
 #include "third_party/WebKit/public/web/WebSpeechRecognizerClient.h"
 
 using blink::WebVector;
 using blink::WebString;
 using blink::WebSpeechGrammar;
 using blink::WebSpeechRecognitionHandle;
 using blink::WebSpeechRecognitionResult;
 using blink::WebSpeechRecognitionParams;
 using blink::WebSpeechRecognizerClient;
 
 namespace content {
 
 SpeechRecognitionDispatcher::SpeechRecognitionDispatcher(
     RenderViewImpl* render_view)
     : RenderViewObserver(render_view),
       recognizer_client_(NULL),
-      next_id_(1) {
-}
+      next_id_(1) {}
 
-SpeechRecognitionDispatcher::~SpeechRecognitionDispatcher() {
-}
+SpeechRecognitionDispatcher::~SpeechRecognitionDispatcher() {}
 
 void SpeechRecognitionDispatcher::AbortAllRecognitions() {
+  speech_audio_sink_.reset();
   Send(new SpeechRecognitionHostMsg_AbortAllRequests(
       routing_id()));
 }
 
 bool SpeechRecognitionDispatcher::OnMessageReceived(
     const IPC::Message& message) {
   bool handled = true;
   IPC_BEGIN_MESSAGE_MAP(SpeechRecognitionDispatcher, message)
     IPC_MESSAGE_HANDLER(SpeechRecognitionMsg_Started, OnRecognitionStarted)
     IPC_MESSAGE_HANDLER(SpeechRecognitionMsg_AudioStarted, OnAudioStarted)
     IPC_MESSAGE_HANDLER(SpeechRecognitionMsg_SoundStarted, OnSoundStarted)
     IPC_MESSAGE_HANDLER(SpeechRecognitionMsg_SoundEnded, OnSoundEnded)
     IPC_MESSAGE_HANDLER(SpeechRecognitionMsg_AudioEnded, OnAudioEnded)
     IPC_MESSAGE_HANDLER(SpeechRecognitionMsg_ErrorOccurred, OnErrorOccurred)
     IPC_MESSAGE_HANDLER(SpeechRecognitionMsg_Ended, OnRecognitionEnded)
     IPC_MESSAGE_HANDLER(SpeechRecognitionMsg_ResultRetrieved,
                         OnResultsRetrieved)
+    IPC_MESSAGE_HANDLER(SpeechRecognitionMsg_AudioTrackReady, OnAudioTrackReady)
     IPC_MESSAGE_UNHANDLED(handled = false)
   IPC_END_MESSAGE_MAP()
   return handled;
 }
 
 void SpeechRecognitionDispatcher::start(
     const WebSpeechRecognitionHandle& handle,
     const WebSpeechRecognitionParams& params,
     WebSpeechRecognizerClient* recognizer_client) {
   DCHECK(!recognizer_client_ || recognizer_client_ == recognizer_client);
   recognizer_client_ = recognizer_client;
 
+  const blink::WebMediaStreamTrack track = params.audioTrack();
+  if (!track.isNull()) {
+    // Check if this type of track is allowed by implemented policy.
+    if (SpeechRecognitionAudioSink::IsSupportedTrack(track)) {
+      audio_track_.assign(track);
+    } else {
+      audio_track_.reset();
+      // Notify user that the track used is not supported.
+      recognizer_client_->didReceiveError(
+          handle,
+          WebString("Provided audioTrack is not supported."),
+          WebSpeechRecognizerClient::AudioCaptureError);
+
+      return;
+    }
+  }
+
+  // Destroy any previous instance to detach from the audio track.
+  // Each new session should reinstantiate the provider once the track is ready.
+  speech_audio_sink_.reset();
+
   SpeechRecognitionHostMsg_StartRequest_Params msg_params;
   for (size_t i = 0; i < params.grammars().size(); ++i) {
     const WebSpeechGrammar& grammar = params.grammars()[i];
     msg_params.grammars.push_back(
         SpeechRecognitionGrammar(grammar.src().spec(), grammar.weight()));
   }
   msg_params.language = base::UTF16ToUTF8(params.language());
   msg_params.max_hypotheses = static_cast<uint32>(params.maxAlternatives());
   msg_params.continuous = params.continuous();
   msg_params.interim_results = params.interimResults();
   msg_params.origin_url = params.origin().toString().utf8();
   msg_params.render_view_id = routing_id();
   msg_params.request_id = GetOrCreateIDForHandle(handle);
+  // fall back to default input when the track is not allowed
+  msg_params.using_audio_track = !audio_track_.isNull();
   // The handle mapping will be removed in |OnRecognitionEnd|.
   Send(new SpeechRecognitionHostMsg_StartRequest(msg_params));
 }
 
 void SpeechRecognitionDispatcher::stop(
     const WebSpeechRecognitionHandle& handle,
     WebSpeechRecognizerClient* recognizer_client) {
+  speech_audio_sink_.reset();
   // Ignore a |stop| issued without a matching |start|.
   if (recognizer_client_ != recognizer_client || !HandleExists(handle))
     return;
   Send(new SpeechRecognitionHostMsg_StopCaptureRequest(
       routing_id(), GetOrCreateIDForHandle(handle)));
 }
 
 void SpeechRecognitionDispatcher::abort(
     const WebSpeechRecognitionHandle& handle,
     WebSpeechRecognizerClient* recognizer_client) {
+  speech_audio_sink_.reset();
   // Ignore an |abort| issued without a matching |start|.
   if (recognizer_client_ != recognizer_client || !HandleExists(handle))
     return;
   Send(new SpeechRecognitionHostMsg_AbortRequest(
       routing_id(), GetOrCreateIDForHandle(handle)));
 }
 
 void SpeechRecognitionDispatcher::OnRecognitionStarted(int request_id) {
   recognizer_client_->didStart(GetHandleFromID(request_id));
 }
@@ skipping 39 matching lines @@
   NOTREACHED();
   return WebSpeechRecognizerClient::OtherError;
 }
 
 void SpeechRecognitionDispatcher::OnErrorOccurred(
     int request_id, const SpeechRecognitionError& error) {
   if (error.code == SPEECH_RECOGNITION_ERROR_NO_MATCH) {
     recognizer_client_->didReceiveNoMatch(GetHandleFromID(request_id),
                                           WebSpeechRecognitionResult());
   } else {
+    speech_audio_sink_.reset();
     recognizer_client_->didReceiveError(
         GetHandleFromID(request_id),
         WebString(),  // TODO(primiano): message?
         WebKitErrorCode(error.code));
   }
 }
 
 void SpeechRecognitionDispatcher::OnRecognitionEnded(int request_id) {
   // TODO(tommi): It is possible that the handle isn't found in the array if
   // the user just refreshed the page. It seems that we then get a notification
   // for the previously loaded instance of the page.
   HandleMap::iterator iter = handle_map_.find(request_id);
   if (iter == handle_map_.end()) {
     DLOG(ERROR) << "OnRecognitionEnded called for a handle that doesn't exist";
   } else {
     WebSpeechRecognitionHandle handle = iter->second;
     // Note: we need to erase the handle from the map *before* calling didEnd.
     // didEnd may call back synchronously to start a new recognition session,
     // and we don't want to delete the handle from the map after that happens.
     handle_map_.erase(request_id);
+    speech_audio_sink_.reset();
     recognizer_client_->didEnd(handle);
   }
 }
 
 void SpeechRecognitionDispatcher::OnResultsRetrieved(
     int request_id, const SpeechRecognitionResults& results) {
   size_t provisional_count = 0;
   SpeechRecognitionResults::const_iterator it = results.begin();
   for (; it != results.end(); ++it) {
     if (it->is_provisional)
@@ skipping 17 matching lines @@
       transcripts[i] = result.hypotheses[i].utterance;
       confidences[i] = static_cast<float>(result.hypotheses[i].confidence);
     }
     webkit_result->assign(transcripts, confidences, !result.is_provisional);
   }
 
   recognizer_client_->didReceiveResults(
       GetHandleFromID(request_id), final, provisional);
 }
 
+void SpeechRecognitionDispatcher::OnAudioTrackReady(
+    int request_id,
+    const media::AudioParameters& params,
+    base::SharedMemoryHandle memory,
+    base::SyncSocket::TransitDescriptor descriptor) {
+  DCHECK(!speech_audio_sink_.get());
+  if (audio_track_.isNull()) {
+    speech_audio_sink_.reset();
+    return;
+  }
+
+  // Create socket here and pass ownership to the |speech_audio_sink_|.
+  scoped_ptr<base::SyncSocket> socket(new base::CancelableSyncSocket(
+      base::SyncSocket::UnwrapHandle(descriptor)));
+
+  speech_audio_sink_.reset(new SpeechRecognitionAudioSink(
+      audio_track_, params, memory, socket.Pass(),
+      base::Bind(&SpeechRecognitionDispatcher::ResetAudioSourceProvider,
+                 base::Unretained(this))));
+}
 
 int SpeechRecognitionDispatcher::GetOrCreateIDForHandle(
     const WebSpeechRecognitionHandle& handle) {
   // Search first for an existing mapping.
   for (HandleMap::iterator iter = handle_map_.begin();
       iter != handle_map_.end();
       ++iter) {
     if (iter->second.equals(handle))
       return iter->first;
   }
   // If no existing mapping found, create a new one.
   const int new_id = next_id_;
   handle_map_[new_id] = handle;
   ++next_id_;
   return new_id;
 }
 
 bool SpeechRecognitionDispatcher::HandleExists(
     const WebSpeechRecognitionHandle& handle) {
   for (HandleMap::iterator iter = handle_map_.begin();
       iter != handle_map_.end();
       ++iter) {
     if (iter->second.equals(handle))
       return true;
   }
   return false;
 }
 
+void SpeechRecognitionDispatcher::ResetAudioSourceProvider() {

[no longer working on chromium, 2014/09/29 09:28:57]

There is no AudioSourceProvider any more, how about changing the name to 
OnAudioTrackStopped()

[burnik, 2014/09/29 10:38:12]

This has been discussed earlier. It would be regarded as an IPC for the reader
if named with "On" prefix. Renamed to "ResetAudioSink" - ready for next
patchset.
Also, this is a bug. Changed to: speech_audio_sink_.reset();

+  audio_track_.reset();
+}
+
 const WebSpeechRecognitionHandle& SpeechRecognitionDispatcher::GetHandleFromID(
     int request_id) {
   HandleMap::iterator iter = handle_map_.find(request_id);
   DCHECK(iter != handle_map_.end());
   return iter->second;
 }
 
 }  // namespace content