src/third_party/WebKit/Source/modules/speech/SpeechRecognition.h

   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 #ifndef SpeechRecognition_h
  27 #define SpeechRecognition_h
  28
  29 #include "core/dom/ActiveDOMObject.h"
  30 #include "modules/EventTargetModules.h"
  31 #include "modules/speech/SpeechGrammarList.h"
  32 #include "modules/speech/SpeechRecognitionResult.h"
  33 #include "platform/heap/Handle.h"
  34 #include "wtf/Compiler.h"
  35 #include "wtf/text/WTFString.h"
  36
  37 namespace blink {
  38
  39 class ExceptionState;
  40 class ExecutionContext;
  41 class MediaStreamTrack;
  42 class SpeechRecognitionController;
  43 class SpeechRecognitionError;
  44
  45 class SpeechRecognition final : public RefCountedGarbageCollectedWillBeGarbageCollectedFinalized<SpeechRecognition>, public ActiveDOMObject, public EventTargetWithInlineData {
  46     DEFINE_EVENT_TARGET_REFCOUNTING_WILL_BE_REMOVED(RefCountedGarbageCollected<SpeechRecognition>);
  47     DEFINE_WRAPPERTYPEINFO();
  48     WILL_BE_USING_GARBAGE_COLLECTED_MIXIN(SpeechRecognition);
  49 public:
  50     static SpeechRecognition* create(ExecutionContext*);
  51     virtual ~SpeechRecognition();
  52
  53     // SpeechRecognition.idl implemementation.
  54     // Attributes.
  55     SpeechGrammarList* grammars() { return m_grammars; }
  56     void setGrammars(SpeechGrammarList* grammars) { m_grammars = grammars; }
  57     String lang() { return m_lang; }
  58     void setLang(const String& lang) { m_lang = lang; }
  59     bool continuous() { return m_continuous; }
  60     void setContinuous(bool continuous) { m_continuous = continuous; }
  61     bool interimResults() { return m_interimResults; }
  62     void setInterimResults(bool interimResults) { m_interimResults = interimResults; }
  63     unsigned long maxAlternatives() { return m_maxAlternatives; }
  64     void setMaxAlternatives(unsigned long maxAlternatives) { m_maxAlternatives = maxAlternatives; }
  65     MediaStreamTrack* audioTrack() { return m_audioTrack; }
  66     void setAudioTrack(MediaStreamTrack* audioTrack) { m_audioTrack = audioTrack; }
  67
  68     // Callable by the user.
  69     void start(ExceptionState&);
  70     void stopFunction();
  71     void abort();
  72
  73     // Called by the SpeechRecognitionClient.
  74     void didStartAudio();
  75     void didStartSound();
  76     void didStartSpeech();
  77     void didEndSpeech();
  78     void didEndSound();
  79     void didEndAudio();
  80     void didReceiveResults(const HeapVector<Member<SpeechRecognitionResult> >& newFinalResults, const HeapVector<Member<SpeechRecognitionResult> >& currentInterimResults);
  81     void didReceiveNoMatch(SpeechRecognitionResult*);
  82     void didReceiveError(PassRefPtrWillBeRawPtr<SpeechRecognitionError>);
  83     void didStart();
  84     void didEnd();
  85
  86     // EventTarget.
  87     virtual const AtomicString& interfaceName() const override;
  88     virtual ExecutionContext* executionContext() const override;
  89
  90     // ActiveDOMObject.
  91     virtual bool hasPendingActivity() const override;
  92     virtual void stop() override;
  93
  94     DEFINE_ATTRIBUTE_EVENT_LISTENER(audiostart);
  95     DEFINE_ATTRIBUTE_EVENT_LISTENER(soundstart);
  96     DEFINE_ATTRIBUTE_EVENT_LISTENER(speechstart);
  97     DEFINE_ATTRIBUTE_EVENT_LISTENER(speechend);
  98     DEFINE_ATTRIBUTE_EVENT_LISTENER(soundend);
  99     DEFINE_ATTRIBUTE_EVENT_LISTENER(audioend);
 100     DEFINE_ATTRIBUTE_EVENT_LISTENER(result);
 101     DEFINE_ATTRIBUTE_EVENT_LISTENER(nomatch);
 102     DEFINE_ATTRIBUTE_EVENT_LISTENER(error);
 103     DEFINE_ATTRIBUTE_EVENT_LISTENER(start);
 104     DEFINE_ATTRIBUTE_EVENT_LISTENER(end);
 105
 106     virtual void trace(Visitor*) override;
 107
 108 private:
 109     explicit SpeechRecognition(ExecutionContext*);
 110
 111     Member<SpeechGrammarList> m_grammars;
 112     Member<MediaStreamTrack> m_audioTrack;
 113     String m_lang;
 114     bool m_continuous;
 115     bool m_interimResults;
 116     unsigned long m_maxAlternatives;
 117
 118     RawPtrWillBeMember<SpeechRecognitionController> m_controller;
 119     bool m_stoppedByActiveDOMObject;
 120     bool m_started;
 121     bool m_stopping;
 122     HeapVector<Member<SpeechRecognitionResult> > m_finalResults;
 123 };
 124
 125 } // namespace blink
 126
 127 #endif // SpeechRecognition_h