Add Pause and Resume to Web TTS & Extension TTS APIs

chrome/browser/speech/extension_api/tts_engine_extension_api.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 "chrome/browser/speech/extension_api/tts_engine_extension_api.h"
 
 #include <string>
 
 #include "base/json/json_writer.h"
 #include "base/values.h"
 #include "chrome/browser/extensions/event_router.h"
 #include "chrome/browser/extensions/extension_service.h"
 #include "chrome/browser/extensions/extension_system.h"
 #include "chrome/browser/profiles/profile.h"
 #include "chrome/browser/speech/extension_api/tts_extension_api.h"
 #include "chrome/browser/speech/extension_api/tts_extension_api_constants.h"
 #include "chrome/browser/speech/tts_controller.h"
 #include "chrome/common/extensions/api/speech/tts_engine_manifest_handler.h"
 #include "chrome/common/extensions/extension.h"
 
 using extensions::Extension;
 
 namespace constants = tts_extension_api_constants;
 
 namespace tts_engine_events {
 const char kOnSpeak[] = "ttsEngine.onSpeak";
 const char kOnStop[] = "ttsEngine.onStop";
+const char kOnPause[] = "ttsEngine.onPause";
+const char kOnResume[] = "ttsEngine.onResume";
 };  // namespace tts_engine_events
 
 void GetExtensionVoices(Profile* profile, std::vector<VoiceData>* out_voices) {
   ExtensionService* service = profile->GetExtensionService();
   DCHECK(service);
   extensions::EventRouter* event_router =
       extensions::ExtensionSystem::Get(profile)->event_router();
   DCHECK(event_router);
 
   const ExtensionSet* extensions = service->extensions();
@@ skipping 86 matching lines @@
 
 void ExtensionTtsEngineStop(Utterance* utterance) {
   scoped_ptr<ListValue> args(new ListValue());
   scoped_ptr<extensions::Event> event(new extensions::Event(
       tts_engine_events::kOnStop, args.Pass()));
   event->restrict_to_profile = utterance->profile();
   extensions::ExtensionSystem::Get(utterance->profile())->event_router()->
       DispatchEventToExtension(utterance->extension_id(), event.Pass());
 }
 
+void ExtensionTtsEnginePause(Utterance* utterance) {
+  scoped_ptr<ListValue> args(new ListValue());
+  scoped_ptr<extensions::Event> event(new extensions::Event(
+      tts_engine_events::kOnPause, args.Pass()));
+  event->restrict_to_profile = utterance->profile();
+  extensions::ExtensionSystem::Get(utterance->profile())->event_router()->
+      DispatchEventToExtension(utterance->extension_id(), event.Pass());
+}
+
+void ExtensionTtsEngineResume(Utterance* utterance) {
+  scoped_ptr<ListValue> args(new ListValue());
+  scoped_ptr<extensions::Event> event(new extensions::Event(
+      tts_engine_events::kOnResume, args.Pass()));
+  event->restrict_to_profile = utterance->profile();
+  extensions::ExtensionSystem::Get(utterance->profile())->event_router()->
+      DispatchEventToExtension(utterance->extension_id(), event.Pass());

[not at google - send to devlin, 2013/05/13 14:46:53]

Consider sending a warning to the console of the target extension if it listens
to onPause but not onResume or vice versa.

I forget where the code is, but look for where the IPC for
ExtensionMsg_AddMessageToConsole originates.

[dmazzoni, 2013/05/14 16:50:27]

You were thinking of UIThreadExtensionFunction::WriteToConsole,
but that's for logging a message to the page that called an extension
function. I had to add a bit more code to log a message to the extension
background page's console - please take a look.

For the record, this isn't needed for onSpeak and onStop because it won't
even route speech to an extension that implements just one of those two.

+}
+
 bool ExtensionTtsEngineSendTtsEventFunction::RunImpl() {
   int utterance_id;
   std::string error_message;
   EXTENSION_FUNCTION_VALIDATE(args_->GetInteger(0, &utterance_id));
 
   DictionaryValue* event;
   EXTENSION_FUNCTION_VALIDATE(args_->GetDictionary(1, &event));
 
   std::string event_type;
   EXTENSION_FUNCTION_VALIDATE(
@@ skipping 41 matching lines @@
     controller->OnTtsEvent(
         utterance_id, TTS_EVENT_SENTENCE, char_index, std::string());
   } else if (event_type == constants::kEventTypeMarker) {
     controller->OnTtsEvent(
         utterance_id, TTS_EVENT_MARKER, char_index, std::string());
   } else if (event_type == constants::kEventTypeError) {
     std::string error_message;
     event->GetString(constants::kErrorMessageKey, &error_message);
     controller->OnTtsEvent(
         utterance_id, TTS_EVENT_ERROR, char_index, error_message);
+  } else if (event_type == constants::kEventTypePause) {
+    controller->OnTtsEvent(
+        utterance_id, TTS_EVENT_PAUSE, char_index, std::string());
+  } else if (event_type == constants::kEventTypeResume) {
+    controller->OnTtsEvent(
+        utterance_id, TTS_EVENT_RESUME, char_index, std::string());
   } else {
     EXTENSION_FUNCTION_VALIDATE(false);
   }
 
   return true;
 }