1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182
|
/*
* Copyright (C) 2012 Google Inc. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* * Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* * Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS ``AS IS'' AND ANY
* EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
* EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
* PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
* PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
* OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
#ifndef THIRD_PARTY_BLINK_RENDERER_MODULES_SPEECH_SPEECH_RECOGNITION_H_
#define THIRD_PARTY_BLINK_RENDERER_MODULES_SPEECH_SPEECH_RECOGNITION_H_
#include "media/base/audio_parameters.h"
#include "media/mojo/mojom/speech_recognizer.mojom-blink.h"
#include "third_party/blink/public/platform/web_private_ptr.h"
#include "third_party/blink/renderer/bindings/core/v8/active_script_wrappable.h"
#include "third_party/blink/renderer/bindings/core/v8/idl_types.h"
#include "third_party/blink/renderer/bindings/core/v8/script_promise.h"
#include "third_party/blink/renderer/bindings/core/v8/script_promise_resolver.h"
#include "third_party/blink/renderer/bindings/modules/v8/v8_availability_status.h"
#include "third_party/blink/renderer/bindings/modules/v8/v8_speech_recognition_mode.h"
#include "third_party/blink/renderer/core/execution_context/execution_context_lifecycle_observer.h"
#include "third_party/blink/renderer/core/page/page_visibility_observer.h"
#include "third_party/blink/renderer/modules/event_target_modules.h"
#include "third_party/blink/renderer/modules/modules_export.h"
#include "third_party/blink/renderer/modules/speech/speech_grammar_list.h"
#include "third_party/blink/renderer/modules/speech/speech_recognition_phrase_list.h"
#include "third_party/blink/renderer/modules/speech/speech_recognition_result.h"
#include "third_party/blink/renderer/platform/heap/garbage_collected.h"
#include "third_party/blink/renderer/platform/mojo/heap_mojo_receiver.h"
#include "third_party/blink/renderer/platform/mojo/heap_mojo_remote.h"
#include "third_party/blink/renderer/platform/wtf/text/wtf_string.h"
namespace media {
class AudioParameters;
} // namespace media
namespace blink {
class ExceptionState;
class ExecutionContext;
class LocalDOMWindow;
class MediaStreamTrack;
class SpeechRecognitionController;
class MODULES_EXPORT SpeechRecognition final
: public EventTarget,
public ActiveScriptWrappable<SpeechRecognition>,
public ExecutionContextLifecycleObserver,
public media::mojom::blink::SpeechRecognitionSessionClient,
public PageVisibilityObserver {
DEFINE_WRAPPERTYPEINFO();
public:
static SpeechRecognition* Create(ExecutionContext*);
SpeechRecognition(LocalDOMWindow*);
~SpeechRecognition() override;
// SpeechRecognition.idl attributes implementation.
SpeechGrammarList* grammars() const { return grammars_.Get(); }
void setGrammars(SpeechGrammarList* grammars) { grammars_ = grammars; }
SpeechRecognitionPhraseList* phrases() const { return phrases_.Get(); }
void setPhrases(SpeechRecognitionPhraseList* phrases);
String lang() const { return lang_; }
void setLang(const String& lang) { lang_ = lang; }
bool continuous() const { return continuous_; }
void setContinuous(bool continuous) { continuous_ = continuous; }
bool interimResults() const { return interim_results_; }
void setInterimResults(bool interim_results) {
interim_results_ = interim_results;
}
unsigned maxAlternatives() const { return max_alternatives_; }
void setMaxAlternatives(unsigned max_alternatives) {
max_alternatives_ = max_alternatives;
}
V8SpeechRecognitionMode mode() const { return mode_; }
void setMode(const V8SpeechRecognitionMode& mode);
// Callable by the user. Methods may be called after the execution context is
// destroyed.
void start(ExceptionState&);
void start(MediaStreamTrack*, ExceptionState&);
void stopFunction();
void abort();
static ScriptPromise<V8AvailabilityStatus>
availableOnDevice(ScriptState*, const String& lang, ExceptionState&);
static ScriptPromise<IDLBoolean> installOnDevice(ScriptState*,
const String& lang,
ExceptionState&);
// media::mojom::blink::SpeechRecognitionSessionClient
void ResultRetrieved(
WTF::Vector<media::mojom::blink::WebSpeechRecognitionResultPtr> results)
override;
void ErrorOccurred(
media::mojom::blink::SpeechRecognitionErrorPtr error) override;
void Started() override;
void AudioStarted() override;
void SoundStarted() override;
void SoundEnded() override;
void AudioEnded() override;
void Ended() override;
// EventTarget
const AtomicString& InterfaceName() const override;
ExecutionContext* GetExecutionContext() const override;
// ScriptWrappable
bool HasPendingActivity() const final;
// ExecutionContextLifecycleObserver
void ContextDestroyed() override;
// PageVisibilityObserver
void PageVisibilityChanged() override;
DEFINE_ATTRIBUTE_EVENT_LISTENER(audiostart, kAudiostart)
DEFINE_ATTRIBUTE_EVENT_LISTENER(soundstart, kSoundstart)
DEFINE_ATTRIBUTE_EVENT_LISTENER(speechstart, kSpeechstart)
DEFINE_ATTRIBUTE_EVENT_LISTENER(speechend, kSpeechend)
DEFINE_ATTRIBUTE_EVENT_LISTENER(soundend, kSoundend)
DEFINE_ATTRIBUTE_EVENT_LISTENER(audioend, kAudioend)
DEFINE_ATTRIBUTE_EVENT_LISTENER(result, kResult)
DEFINE_ATTRIBUTE_EVENT_LISTENER(nomatch, kNomatch)
DEFINE_ATTRIBUTE_EVENT_LISTENER(error, kError)
DEFINE_ATTRIBUTE_EVENT_LISTENER(start, kStart)
DEFINE_ATTRIBUTE_EVENT_LISTENER(end, kEnd)
void Trace(Visitor*) const override;
private:
void OnConnectionError();
void CheckAvailabilityAndStart(ExceptionState* exception_state);
void StartInternal();
void StartController(
mojo::PendingReceiver<media::mojom::blink::SpeechRecognitionSession>
session_receiver,
std::optional<media::AudioParameters> audio_parameters = std::nullopt,
mojo::PendingReceiver<
media::mojom::blink::SpeechRecognitionAudioForwarder>
audio_forwarder_receiver = mojo::NullReceiver());
Member<MediaStreamTrack> stream_track_;
Member<SpeechGrammarList> grammars_;
Member<SpeechRecognitionPhraseList> phrases_;
String lang_;
bool continuous_ = false;
bool interim_results_ = false;
uint32_t max_alternatives_ = 1;
V8SpeechRecognitionMode mode_ = V8SpeechRecognitionMode{
V8SpeechRecognitionMode::Enum::kOndevicePreferred};
Member<SpeechRecognitionController> controller_;
bool started_ = false;
bool stopping_ = false;
HeapVector<Member<SpeechRecognitionResult>> final_results_;
HeapMojoReceiver<media::mojom::blink::SpeechRecognitionSessionClient,
SpeechRecognition>
receiver_;
HeapMojoRemote<media::mojom::blink::SpeechRecognitionSession> session_;
};
} // namespace blink
#endif // THIRD_PARTY_BLINK_RENDERER_MODULES_SPEECH_SPEECH_RECOGNITION_H_
|