speech_recognition_dispatcher_host.cc revision 2a99a7e74a7f215066514fe81d2bfa6639d9eddd
15821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Copyright (c) 2012 The Chromium Authors. All rights reserved.
25821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Use of this source code is governed by a BSD-style license that can be
35821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// found in the LICENSE file.
45821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
55821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "content/browser/speech/speech_recognition_dispatcher_host.h"
65821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
75821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "base/bind.h"
85821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "base/command_line.h"
95821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "base/lazy_instance.h"
105821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "content/common/speech_recognition_messages.h"
115821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "content/public/browser/speech_recognition_manager.h"
125821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "content/public/browser/speech_recognition_preferences.h"
135821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "content/public/browser/speech_recognition_session_config.h"
145821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "content/public/browser/speech_recognition_session_context.h"
155821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "content/public/common/content_switches.h"
165821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
175821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)namespace content {
185821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)SpeechRecognitionManager* SpeechRecognitionDispatcherHost::manager_for_tests_;
195821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
205821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)void SpeechRecognitionDispatcherHost::SetManagerForTests(
215821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)    SpeechRecognitionManager* manager) {
225821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  manager_for_tests_ = manager;
235821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}
245821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
255821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)SpeechRecognitionDispatcherHost::SpeechRecognitionDispatcherHost(
265821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)    int render_process_id,
275821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)    net::URLRequestContextGetter* context_getter,
285821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)    SpeechRecognitionPreferences* recognition_preferences)
295821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)    : render_process_id_(render_process_id),
305821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)      context_getter_(context_getter),
315821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)      recognition_preferences_(recognition_preferences) {
325821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  // Do not add any non-trivial initialization here, instead do it lazily when
335821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  // required (e.g. see the method |manager()|) or add an Init() method.
345821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}
355821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
365821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)SpeechRecognitionDispatcherHost::~SpeechRecognitionDispatcherHost() {
375821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  if (SpeechRecognitionManager* sr_manager = manager())
385821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)    sr_manager->AbortAllSessionsForListener(this);
395821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}
405821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
415821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)SpeechRecognitionManager* SpeechRecognitionDispatcherHost::manager() {
425821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  if (manager_for_tests_)
435821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)    return manager_for_tests_;
445821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
452a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)  return SpeechRecognitionManager::GetInstance();
465821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}
475821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
485821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)bool SpeechRecognitionDispatcherHost::OnMessageReceived(
495821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)    const IPC::Message& message, bool* message_was_ok) {
505821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  bool handled = true;
515821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  IPC_BEGIN_MESSAGE_MAP_EX(SpeechRecognitionDispatcherHost, message,
525821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)                           *message_was_ok)
535821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)    IPC_MESSAGE_HANDLER(SpeechRecognitionHostMsg_StartRequest,
545821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)                        OnStartRequest)
555821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)    IPC_MESSAGE_HANDLER(SpeechRecognitionHostMsg_AbortRequest,
565821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)                        OnAbortRequest)
575821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)    IPC_MESSAGE_HANDLER(SpeechRecognitionHostMsg_StopCaptureRequest,
585821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)                        OnStopCaptureRequest)
595821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)    IPC_MESSAGE_UNHANDLED(handled = false)
605821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  IPC_END_MESSAGE_MAP()
615821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  return handled;
625821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}
635821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
645821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)void SpeechRecognitionDispatcherHost::OnStartRequest(
655821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)    const SpeechRecognitionHostMsg_StartRequest_Params& params) {
665821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
675821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  SpeechRecognitionSessionContext context;
685821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  context.context_name = params.origin_url;
695821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  context.render_process_id = render_process_id_;
705821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  context.render_view_id = params.render_view_id;
715821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  context.request_id = params.request_id;
725821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  context.requested_by_page_element = false;
735821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
745821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  SpeechRecognitionSessionConfig config;
755821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  config.is_legacy_api = false;
765821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  config.language = params.language;
775821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  config.grammars = params.grammars;
785821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  config.max_hypotheses = params.max_hypotheses;
795821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  config.origin_url = params.origin_url;
805821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  config.initial_context = context;
815821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  config.url_request_context_getter = context_getter_.get();
825821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  if (recognition_preferences_) {
835821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)    config.filter_profanities = recognition_preferences_->FilterProfanities();
845821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  } else {
855821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)    config.filter_profanities = false;
865821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  }
875821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  config.continuous = params.continuous;
885821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  config.interim_results = params.interim_results;
895821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  config.event_listener = this;
905821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
915821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  int session_id = manager()->CreateSession(config);
925821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  DCHECK_NE(session_id, SpeechRecognitionManager::kSessionIDInvalid);
935821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  manager()->StartSession(session_id);
945821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}
955821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
965821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)void SpeechRecognitionDispatcherHost::OnAbortRequest(int render_view_id,
975821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)                                                     int request_id) {
985821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  int session_id = manager()->GetSession(render_process_id_,
995821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)                                         render_view_id,
1005821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)                                         request_id);
1015821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
1025821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  // The renderer might provide an invalid |request_id| if the session was not
1035821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  // started as expected, e.g., due to unsatisfied security requirements.
1045821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  if (session_id != SpeechRecognitionManager::kSessionIDInvalid)
1055821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)    manager()->AbortSession(session_id);
1065821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}
1075821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
1085821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)void SpeechRecognitionDispatcherHost::OnStopCaptureRequest(
1095821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)    int render_view_id, int request_id) {
1105821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  int session_id = manager()->GetSession(render_process_id_,
1115821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)                                         render_view_id,
1125821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)                                         request_id);
1135821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
1145821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  // The renderer might provide an invalid |request_id| if the session was not
1155821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  // started as expected, e.g., due to unsatisfied security requirements.
1165821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  if (session_id != SpeechRecognitionManager::kSessionIDInvalid)
1175821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)    manager()->StopAudioCaptureForSession(session_id);
1185821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}
1195821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
1205821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// -------- SpeechRecognitionEventListener interface implementation -----------
1215821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
1225821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)void SpeechRecognitionDispatcherHost::OnRecognitionStart(int session_id) {
1235821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  const SpeechRecognitionSessionContext& context =
1245821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)      manager()->GetSessionContext(session_id);
1255821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  Send(new SpeechRecognitionMsg_Started(context.render_view_id,
1265821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)                                        context.request_id));
1275821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}
1285821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
1295821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)void SpeechRecognitionDispatcherHost::OnAudioStart(int session_id) {
1305821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  const SpeechRecognitionSessionContext& context =
1315821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)      manager()->GetSessionContext(session_id);
1325821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  Send(new SpeechRecognitionMsg_AudioStarted(context.render_view_id,
1335821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)                                             context.request_id));
1345821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}
1355821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
1365821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)void SpeechRecognitionDispatcherHost::OnSoundStart(int session_id) {
1375821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  const SpeechRecognitionSessionContext& context =
1385821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)      manager()->GetSessionContext(session_id);
1395821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  Send(new SpeechRecognitionMsg_SoundStarted(context.render_view_id,
1405821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)                                             context.request_id));
1415821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}
1425821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
1435821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)void SpeechRecognitionDispatcherHost::OnSoundEnd(int session_id) {
1445821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  const SpeechRecognitionSessionContext& context =
1455821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)      manager()->GetSessionContext(session_id);
1465821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  Send(new SpeechRecognitionMsg_SoundEnded(context.render_view_id,
1475821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)                                           context.request_id));
1485821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}
1495821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
1505821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)void SpeechRecognitionDispatcherHost::OnAudioEnd(int session_id) {
1515821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  const SpeechRecognitionSessionContext& context =
1525821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)      manager()->GetSessionContext(session_id);
1535821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  Send(new SpeechRecognitionMsg_AudioEnded(context.render_view_id,
1545821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)                                           context.request_id));
1555821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}
1565821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
1575821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)void SpeechRecognitionDispatcherHost::OnRecognitionEnd(int session_id) {
1585821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  const SpeechRecognitionSessionContext& context =
1595821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)      manager()->GetSessionContext(session_id);
1605821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  Send(new SpeechRecognitionMsg_Ended(context.render_view_id,
1615821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)                                      context.request_id));
1625821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}
1635821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
1642a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)void SpeechRecognitionDispatcherHost::OnRecognitionResults(
1655821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)    int session_id,
1662a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)    const SpeechRecognitionResults& results) {
1675821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  const SpeechRecognitionSessionContext& context =
1685821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)      manager()->GetSessionContext(session_id);
1695821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  Send(new SpeechRecognitionMsg_ResultRetrieved(context.render_view_id,
1705821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)                                                context.request_id,
1712a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)                                                results));
1725821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}
1735821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
1745821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)void SpeechRecognitionDispatcherHost::OnRecognitionError(
1755821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)    int session_id,
1765821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)    const SpeechRecognitionError& error) {
1775821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  const SpeechRecognitionSessionContext& context =
1785821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)      manager()->GetSessionContext(session_id);
1795821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  Send(new SpeechRecognitionMsg_ErrorOccurred(context.render_view_id,
1805821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)                                              context.request_id,
1815821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)                                              error));
1825821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}
1835821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
1845821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// The events below are currently not used by speech JS APIs implementation.
1855821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)void SpeechRecognitionDispatcherHost::OnAudioLevelsChange(int session_id,
1865821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)                                                          float volume,
1875821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)                                                          float noise_volume) {
1885821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}
1895821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
1905821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)void SpeechRecognitionDispatcherHost::OnEnvironmentEstimationComplete(
1915821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)    int session_id) {
1925821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}
1935821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
1945821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}  // namespace content
195