Introducing new data types and IPC messages for scripted JS speech recognition APIs (Speech CL2.0)

content/common/speech_recognition_messages.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.
 
 // Multiply-included message file, hence no include guard.
 
 #include <string>
 
 #include "content/public/common/speech_recognition_error.h"
+#include "content/public/common/speech_recognition_grammar.h"
 #include "content/public/common/speech_recognition_result.h"
 #include "ipc/ipc_message_macros.h"
 #include "ipc/ipc_param_traits.h"
 #include "ui/gfx/rect.h"
 
 #define IPC_MESSAGE_START SpeechRecognitionMsgStart
 
+IPC_ENUM_TRAITS(content::SpeechAudioErrorDetails)
 IPC_ENUM_TRAITS(content::SpeechRecognitionErrorCode)
 
+IPC_STRUCT_TRAITS_BEGIN(content::SpeechRecognitionError)
+  IPC_STRUCT_TRAITS_MEMBER(code)
+  IPC_STRUCT_TRAITS_MEMBER(details)
+IPC_STRUCT_TRAITS_END()
+
 IPC_STRUCT_TRAITS_BEGIN(content::SpeechRecognitionHypothesis)
   IPC_STRUCT_TRAITS_MEMBER(utterance)
   IPC_STRUCT_TRAITS_MEMBER(confidence)
 IPC_STRUCT_TRAITS_END()
 
 IPC_STRUCT_TRAITS_BEGIN(content::SpeechRecognitionResult)
+  IPC_STRUCT_TRAITS_MEMBER(provisional)
   IPC_STRUCT_TRAITS_MEMBER(hypotheses)
 IPC_STRUCT_TRAITS_END()
 
+IPC_STRUCT_TRAITS_BEGIN(content::SpeechRecognitionGrammar)
+  IPC_STRUCT_TRAITS_MEMBER(url)
+  IPC_STRUCT_TRAITS_MEMBER(weight)
+IPC_STRUCT_TRAITS_END()
+
 // Used to start a speech recognition session.
 IPC_STRUCT_BEGIN(InputTagSpeechHostMsg_StartRecognition_Params)
   // The render view requesting speech recognition.
   IPC_STRUCT_MEMBER(int, render_view_id)
   // Request ID used within the render view.
   IPC_STRUCT_MEMBER(int, request_id)
   // Position of the UI element in page coordinates.
   IPC_STRUCT_MEMBER(gfx::Rect, element_rect)
   // Language to use for speech recognition.
   IPC_STRUCT_MEMBER(std::string, language)
   // Speech grammar given by the speech recognition element.
   IPC_STRUCT_MEMBER(std::string, grammar)
   // URL of the page (or iframe if applicable).
   IPC_STRUCT_MEMBER(std::string, origin_url)
 IPC_STRUCT_END()
 
-// Speech recognition messages sent from the renderer to the browser.
+// Renderer -> Browser messages.
 
 // Requests the speech recognition service to start speech recognition on behalf
 // of the given |render_view_id|.
 IPC_MESSAGE_CONTROL1(InputTagSpeechHostMsg_StartRecognition,
                      InputTagSpeechHostMsg_StartRecognition_Params)
 
 // Requests the speech recognition service to cancel speech recognition on
 // behalf of the given |render_view_id|. If speech recognition is not happening
 // or is happening on behalf of some other render view, this call does nothing.
 IPC_MESSAGE_CONTROL2(InputTagSpeechHostMsg_CancelRecognition,
                      int /* render_view_id */,
                      int /* request_id */)
 
 // Requests the speech recognition service to stop audio recording on behalf of
 // the given |render_view_id|. Any audio recorded so far will be fed to the
 // speech recognizer. If speech recognition is not happening nor or is
 // happening on behalf of some other render view, this call does nothing.
 IPC_MESSAGE_CONTROL2(InputTagSpeechHostMsg_StopRecording,
                      int /* render_view_id */,
                      int /* request_id */)
 
-// Speech recognition messages sent from the browser to the renderer.
+// Browser -> Renderer messages.
 
 // Relay a speech recognition result, either partial or final.
 IPC_MESSAGE_ROUTED2(InputTagSpeechMsg_SetRecognitionResult,
                     int /* request_id */,
                     content::SpeechRecognitionResult /* result */)
 
 // Indicate that speech recognizer has stopped recording and started
 // recognition.
 IPC_MESSAGE_ROUTED1(InputTagSpeechMsg_RecordingComplete,
                     int /* request_id */)
 
 // Indicate that speech recognizer has completed recognition. This will be the
 // last message sent in response to a InputTagSpeechHostMsg_StartRecognition.
 IPC_MESSAGE_ROUTED1(InputTagSpeechMsg_RecognitionComplete,
                     int /* request_id */)
 
 // Toggle speech recognition on or off on the speech input control for the
 // current focused element. Has no effect if the current element doesn't
 // support speech recognition.
 IPC_MESSAGE_ROUTED0(InputTagSpeechMsg_ToggleSpeechInput)
+
+
+// ------- Messages for Speech JS APIs (SpeechRecognitionDispatcher) ----------
+
+// Used to start a speech recognition session.
+IPC_STRUCT_BEGIN(SpeechRecognitionHostMsg_StartRequest_Params)
+  // The render view requesting speech recognition.
+  IPC_STRUCT_MEMBER(int, render_view_id)
+  // Unique ID associated to the JS object making the calls.
+  IPC_STRUCT_MEMBER(int, js_handle_id)
+  // Language to use for speech recognition.
+  IPC_STRUCT_MEMBER(std::string, language)
+  // Speech grammar to use.

[hans, 2012/04/26 16:23:25]

nit: s/grammar/grammars/

[Primiano Tucci (use gerrit), 2012/04/27 09:27:13]

Done.

+  IPC_STRUCT_MEMBER(content::SpeechRecognitionGrammarArray, grammars)
+  // URL of the page (or iframe if applicable).
+  IPC_STRUCT_MEMBER(std::string, origin_url)
+  // Continuous recognition mode.
+  IPC_STRUCT_MEMBER(bool, continuous)
+IPC_STRUCT_END()
+
+// Render -> Browser messages.
+
+// Requests the speech recognition service to start speech recognition on behalf
+// of the given |render_view_id|.
+IPC_MESSAGE_CONTROL1(SpeechRecognitionHostMsg_StartRequest,
+                     SpeechRecognitionHostMsg_StartRequest_Params)
+
+// Requests the speech recognition service to abort speech recognition on
+// behalf of the given |render_view_id|. If speech recognition is not happening
+// or is happening on behalf of some other render view, this call does nothing.
+IPC_MESSAGE_CONTROL2(SpeechRecognitionHostMsg_AbortRequest,
+                     int /* render_view_id */,
+                     int /* js_handle_id */)
+
+// Requests the speech recognition service to stop audio capture on behalf of
+// the given |render_view_id|. Any audio recorded so far will be fed to the
+// speech recognizer. If speech recognition is not happening nor or is
+// happening on behalf of some other render view, this call does nothing.
+IPC_MESSAGE_CONTROL2(SpeechRecognitionHostMsg_StopCaptureRequest,
+                     int /* render_view_id */,
+                     int /* js_handle_id */)
+
+// Browser -> Render messages.
+
+IPC_MESSAGE_ROUTED2(SpeechRecognitionMsg_ResultRetrieved,

[hans, 2012/04/26 16:23:25]

we should probably have comments for this, and the messages below too..

+                    int /* js_handle_id */,
+                    content::SpeechRecognitionResult /* result */)
+
+IPC_MESSAGE_ROUTED2(SpeechRecognitionMsg_ErrorOccurred,
+                    int /* js_handle_id */,
+                    content::SpeechRecognitionError /* error */)
+
+IPC_MESSAGE_ROUTED1(SpeechRecognitionMsg_Started, int /* js_handle_id */)
+IPC_MESSAGE_ROUTED1(SpeechRecognitionMsg_AudioStarted, int /* js_handle_id */)
+IPC_MESSAGE_ROUTED1(SpeechRecognitionMsg_SoundStarted, int /* js_handle_id */)
+IPC_MESSAGE_ROUTED1(SpeechRecognitionMsg_SoundEnded, int /* js_handle_id */)
+IPC_MESSAGE_ROUTED1(SpeechRecognitionMsg_AudioEnded, int /* js_handle_id */)
+IPC_MESSAGE_ROUTED1(SpeechRecognitionMsg_Ended, int /* js_handle_id */)