third_party/WebKit/Source/modules/speech/SpeechRecognition.cpp

   1 /*
   2  * Copyright (C) 2012 Google Inc. All rights reserved.
   3  *
   4  * Redistribution and use in source and binary forms, with or without
   5  * modification, are permitted provided that the following conditions
   6  * are met:
   7  *  * Redistributions of source code must retain the above copyright
   8  *    notice, this list of conditions and the following disclaimer.
   9  *  * Redistributions in binary form must reproduce the above copyright
  10  *    notice, this list of conditions and the following disclaimer in the
  11  *    documentation and/or other materials provided with the distribution.
  12  *
  13  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS ``AS IS'' AND ANY
  14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  16  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT OWNER OR
  17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
  18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
  19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
  20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
  21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  24  */
  25
  26 #include "config.h"
  27
  28 #include "modules/speech/SpeechRecognition.h"
  29
  30 #include "bindings/core/v8/ExceptionState.h"
  31 #include "core/dom/Document.h"
  32 #include "core/dom/ExceptionCode.h"
  33 #include "core/page/Page.h"
  34 #include "modules/mediastream/MediaStreamTrack.h"
  35 #include "modules/speech/SpeechRecognitionController.h"
  36 #include "modules/speech/SpeechRecognitionError.h"
  37 #include "modules/speech/SpeechRecognitionEvent.h"
  38
  39 namespace blink {
  40
  41 SpeechRecognition* SpeechRecognition::create(ExecutionContext* context)
  42 {
  43     ASSERT(context && context->isDocument());
  44     Document* document = toDocument(context);
  45     ASSERT(document);
  46     SpeechRecognition* speechRecognition = new SpeechRecognition(document->page(), context);
  47     speechRecognition->suspendIfNeeded();
  48     return speechRecognition;
  49 }
  50
  51 void SpeechRecognition::start(ExceptionState& exceptionState)
  52 {
  53     if (!m_controller)
  54         return;
  55
  56     if (m_started) {
  57         exceptionState.throwDOMException(InvalidStateError, "recognition has already started.");
  58         return;
  59     }
  60
  61     m_finalResults.clear();
  62     m_controller->start(this, m_grammars, m_lang, m_serviceURI, m_continuous, m_interimResults, m_maxAlternatives, m_audioTrack);
  63     m_started = true;
  64 }
  65
  66 void SpeechRecognition::stopFunction()
  67 {
  68     if (!m_controller)
  69         return;
  70
  71     if (m_started && !m_stopping) {
  72         m_stopping = true;
  73         m_controller->stop(this);
  74     }
  75 }
  76
  77 void SpeechRecognition::abort()
  78 {
  79     if (!m_controller)
  80         return;
  81
  82     if (m_started && !m_stopping) {
  83         m_stopping = true;
  84         m_controller->abort(this);
  85     }
  86 }
  87
  88 void SpeechRecognition::didStartAudio()
  89 {
  90     dispatchEvent(Event::create(EventTypeNames::audiostart));
  91 }
  92
  93 void SpeechRecognition::didStartSound()
  94 {
  95     dispatchEvent(Event::create(EventTypeNames::soundstart));
  96 }
  97
  98 void SpeechRecognition::didStartSpeech()
  99 {
 100     dispatchEvent(Event::create(EventTypeNames::speechstart));
 101 }
 102
 103 void SpeechRecognition::didEndSpeech()
 104 {
 105     dispatchEvent(Event::create(EventTypeNames::speechend));
 106 }
 107
 108 void SpeechRecognition::didEndSound()
 109 {
 110     dispatchEvent(Event::create(EventTypeNames::soundend));
 111 }
 112
 113 void SpeechRecognition::didEndAudio()
 114 {
 115     dispatchEvent(Event::create(EventTypeNames::audioend));
 116 }
 117
 118 void SpeechRecognition::didReceiveResults(const HeapVector<Member<SpeechRecognitionResult>>& newFinalResults, const HeapVector<Member<SpeechRecognitionResult>>& currentInterimResults)
 119 {
 120     size_t resultIndex = m_finalResults.size();
 121
 122     for (size_t i = 0; i < newFinalResults.size(); ++i)
 123         m_finalResults.append(newFinalResults[i]);
 124
 125     HeapVector<Member<SpeechRecognitionResult>> results = m_finalResults;
 126     for (size_t i = 0; i < currentInterimResults.size(); ++i)
 127         results.append(currentInterimResults[i]);
 128
 129     dispatchEvent(SpeechRecognitionEvent::createResult(resultIndex, results));
 130 }
 131
 132 void SpeechRecognition::didReceiveNoMatch(SpeechRecognitionResult* result)
 133 {
 134     dispatchEvent(SpeechRecognitionEvent::createNoMatch(result));
 135 }
 136
 137 void SpeechRecognition::didReceiveError(PassRefPtrWillBeRawPtr<SpeechRecognitionError> error)
 138 {
 139     dispatchEvent(error);
 140     m_started = false;
 141 }
 142
 143 void SpeechRecognition::didStart()
 144 {
 145     dispatchEvent(Event::create(EventTypeNames::start));
 146 }
 147
 148 void SpeechRecognition::didEnd()
 149 {
 150     m_started = false;
 151     m_stopping = false;
 152     if (!m_stoppedByActiveDOMObject)
 153         dispatchEvent(Event::create(EventTypeNames::end));
 154 }
 155
 156 const AtomicString& SpeechRecognition::interfaceName() const
 157 {
 158     return EventTargetNames::SpeechRecognition;
 159 }
 160
 161 ExecutionContext* SpeechRecognition::executionContext() const
 162 {
 163     return ActiveDOMObject::executionContext();
 164 }
 165
 166 void SpeechRecognition::stop()
 167 {
 168     m_stoppedByActiveDOMObject = true;
 169     if (hasPendingActivity())
 170         abort();
 171 }
 172
 173 bool SpeechRecognition::hasPendingActivity() const
 174 {
 175     return m_started;
 176 }
 177
 178 SpeechRecognition::SpeechRecognition(Page* page, ExecutionContext* context)
 179     : PageLifecycleObserver(page)
 180     , ActiveDOMObject(context)
 181     , m_grammars(SpeechGrammarList::create()) // FIXME: The spec is not clear on the default value for the grammars attribute.
 182     , m_audioTrack(nullptr)
 183     , m_continuous(false)
 184     , m_interimResults(false)
 185     , m_maxAlternatives(1)
 186     , m_controller(SpeechRecognitionController::from(page))
 187     , m_stoppedByActiveDOMObject(false)
 188     , m_started(false)
 189     , m_stopping(false)
 190 {
 191     // FIXME: Need to hook up with Page to get notified when the visibility changes.
 192 }
 193
 194 SpeechRecognition::~SpeechRecognition()
 195 {
 196 }
 197
 198 void SpeechRecognition::contextDestroyed()
 199 {
 200     m_controller = nullptr;
 201     PageLifecycleObserver::contextDestroyed();
 202 }
 203
 204 DEFINE_TRACE(SpeechRecognition)
 205 {
 206     visitor->trace(m_grammars);
 207     visitor->trace(m_audioTrack);
 208     visitor->trace(m_controller);
 209     visitor->trace(m_finalResults);
 210     RefCountedGarbageCollectedEventTargetWithInlineData<SpeechRecognition>::trace(visitor);
 211     PageLifecycleObserver::trace(visitor);
 212     ActiveDOMObject::trace(visitor);
 213 }
 214
 215 } // namespace blink