Allow PlatformSpeechSynthesiser to report error code on failure

asurdej-comcast · asurdej-comcast · commit dc10130729c1 · 2022-05-26T10:35:38.000+02:00
Extend speakingErrorOccurred() of PlatformSpeechSynthesizerClient
with SpeechError code that reflects the source of failure.
diff --git a/Source/WebCore/Modules/speech/SpeechSynthesis.cpp b/Source/WebCore/Modules/speech/SpeechSynthesis.cpp
@@ -41,6 +41,26 @@
 #include <wtf/IsoMallocInlines.h>
 #include <wtf/NeverDestroyed.h>
 
+namespace {
+WebCore::SpeechSynthesisErrorCode toSpeechSynthesisErrorEventCode(WebCore::SpeechError error) {
+    switch(error) {
+        case WebCore::SpeechError::Canceled:               return WebCore::SpeechSynthesisErrorCode::Canceled;
+        case WebCore::SpeechError::Interrupted:            return WebCore::SpeechSynthesisErrorCode::Interrupted;
+        case WebCore::SpeechError::AudioBusy:              return WebCore::SpeechSynthesisErrorCode::AudioBusy;
+        case WebCore::SpeechError::AudioHardware:          return WebCore::SpeechSynthesisErrorCode::AudioHardware;
+        case WebCore::SpeechError::Network:                return WebCore::SpeechSynthesisErrorCode::Network;
+        case WebCore::SpeechError::SynthesisUnavailable:   return WebCore::SpeechSynthesisErrorCode::SynthesisUnavailable;
+        case WebCore::SpeechError::SynthesisFailed:        return WebCore::SpeechSynthesisErrorCode::SynthesisFailed;
+        case WebCore::SpeechError::LanguageUnavailable:    return WebCore::SpeechSynthesisErrorCode::LanguageUnavailable;
+        case WebCore::SpeechError::VoiceUnavailable:       return WebCore::SpeechSynthesisErrorCode::VoiceUnavailable;
+        case WebCore::SpeechError::TextTooLong:            return WebCore::SpeechSynthesisErrorCode::TextTooLong;
+        case WebCore::SpeechError::InvalidArgument:        return WebCore::SpeechSynthesisErrorCode::InvalidArgument;
+        case WebCore::SpeechError::NotAllowed:             return WebCore::SpeechSynthesisErrorCode::NotAllowed;
+        default: ASSERT(false, "Invalid SpeechError code"); return WebCore::SpeechSynthesisErrorCode::Interrupted;
+    }
+}
+} // namespace
+
 namespace WebCore {
 
 WTF_MAKE_ISO_ALLOCATED_IMPL(SpeechSynthesis);
@@ -207,18 +227,20 @@ void SpeechSynthesis::fireErrorEvent(const AtomString& type, SpeechSynthesisUtte
     utterance.dispatchEvent(SpeechSynthesisErrorEvent::create(type, { { &utterance, 0, 0, static_cast<float>((MonotonicTime::now() - utterance.startTime()).seconds()), { } }, errorCode }));
 }
 
-void SpeechSynthesis::handleSpeakingCompleted(SpeechSynthesisUtterance& utterance, bool errorOccurred)
+void SpeechSynthesis::handleSpeakingCompleted(SpeechSynthesisUtterance& utterance, bool errorOccurred, SpeechError error)
 {
     ASSERT(m_currentSpeechUtterance);
     Ref<SpeechSynthesisUtterance> protect(utterance);
 
-    m_currentSpeechUtterance = nullptr;
+    if (m_currentSpeechUtterance == &utterance)
+        m_currentSpeechUtterance = nullptr;
 
-    if (errorOccurred)
-        fireErrorEvent(eventNames().errorEvent, utterance, SpeechSynthesisErrorCode::Canceled);
+    // For PlatformSpeechSynthesizer(s) that don't support ErrorEvent yet
+    if (errorOccurred && error != SpeechError::None)
+        fireErrorEvent(eventNames().errorEvent, utterance, toSpeechSynthesisErrorEventCode(error));
     else
         fireEvent(eventNames().endEvent, utterance, 0, 0, String());
-    
+
     if (m_utteranceQueue.size()) {
         Ref<SpeechSynthesisUtterance> firstUtterance = m_utteranceQueue.takeFirst();
         ASSERT(&utterance == firstUtterance.ptr());
@@ -280,7 +302,7 @@ void SpeechSynthesis::speakingErrorOccurred()
 {
     if (!m_currentSpeechUtterance)
         return;
-    speakingErrorOccurred(*m_currentSpeechUtterance->platformUtterance());
+    speakingErrorOccurred(*m_currentSpeechUtterance->platformUtterance(), SpeechError::None);
 }
 
 void SpeechSynthesis::boundaryEventOccurred(bool wordBoundary, unsigned charIndex, unsigned charLength)
@@ -321,10 +343,10 @@ void SpeechSynthesis::didFinishSpeaking(PlatformSpeechSynthesisUtterance& uttera
         handleSpeakingCompleted(static_cast<SpeechSynthesisUtterance&>(*utterance.client()), false);
 }
 
-void SpeechSynthesis::speakingErrorOccurred(PlatformSpeechSynthesisUtterance& utterance)
+void SpeechSynthesis::speakingErrorOccurred(PlatformSpeechSynthesisUtterance& utterance, SpeechError error)
 {
     if (utterance.client())
-        handleSpeakingCompleted(static_cast<SpeechSynthesisUtterance&>(*utterance.client()), true);
+        handleSpeakingCompleted(static_cast<SpeechSynthesisUtterance&>(*utterance.client()), true, error);
 }
 
 } // namespace WebCore
diff --git a/Source/WebCore/Modules/speech/SpeechSynthesis.h b/Source/WebCore/Modules/speech/SpeechSynthesis.h
@@ -73,7 +73,7 @@ class SpeechSynthesis : public PlatformSpeechSynthesizerClient, public SpeechSyn
     void didPauseSpeaking(PlatformSpeechSynthesisUtterance&) override;
     void didResumeSpeaking(PlatformSpeechSynthesisUtterance&) override;
     void didFinishSpeaking(PlatformSpeechSynthesisUtterance&) override;
-    void speakingErrorOccurred(PlatformSpeechSynthesisUtterance&) override;
+    void speakingErrorOccurred(PlatformSpeechSynthesisUtterance&, SpeechError) override;
     void boundaryEventOccurred(PlatformSpeechSynthesisUtterance&, SpeechBoundary, unsigned charIndex, unsigned charLength) override;
 
     // SpeechSynthesisClient override methods
@@ -84,9 +84,9 @@ class SpeechSynthesis : public PlatformSpeechSynthesizerClient, public SpeechSyn
     void speakingErrorOccurred() override;
     void boundaryEventOccurred(bool wordBoundary, unsigned charIndex, unsigned charLength) override;
     void voicesChanged() override;
-    
+
     void startSpeakingImmediately(SpeechSynthesisUtterance&);
-    void handleSpeakingCompleted(SpeechSynthesisUtterance&, bool errorOccurred);
+    void handleSpeakingCompleted(SpeechSynthesisUtterance&, bool errorOccurred, SpeechError error = SpeechError::None);
     void fireEvent(const AtomString& type, SpeechSynthesisUtterance&, unsigned long charIndex, unsigned long charLength, const String& name) const;
     void fireErrorEvent(const AtomString& type, SpeechSynthesisUtterance&, SpeechSynthesisErrorCode) const;
 
@@ -99,14 +99,14 @@ class SpeechSynthesis : public PlatformSpeechSynthesizerClient, public SpeechSyn
 
     bool userGestureRequiredForSpeechStart() const { return m_restrictions & RequireUserGestureForSpeechStartRestriction; }
     void removeBehaviorRestriction(BehaviorRestrictions restriction) { m_restrictions &= ~restriction; }
-    
+
     ScriptExecutionContext* scriptExecutionContext() const final { return ContextDestructionObserver::scriptExecutionContext(); }
     EventTargetInterface eventTargetInterface() const final { return SpeechSynthesisEventTargetInterfaceType; }
     void refEventTarget() final { ref(); }
     void derefEventTarget() final { deref(); }
-    
+
     PlatformSpeechSynthesizer& ensurePlatformSpeechSynthesizer();
-    
+
     std::unique_ptr<PlatformSpeechSynthesizer> m_platformSpeechSynthesizer;
     Vector<Ref<SpeechSynthesisVoice>> m_voiceList;
     RefPtr<SpeechSynthesisUtterance> m_currentSpeechUtterance;
diff --git a/Source/WebCore/platform/PlatformSpeechSynthesizer.h b/Source/WebCore/platform/PlatformSpeechSynthesizer.h
@@ -38,6 +38,22 @@ OBJC_CLASS WebSpeechSynthesisWrapper;
 
 namespace WebCore {
 
+enum class SpeechError : uint8_t {
+    None,
+    Canceled,
+    Interrupted,
+    AudioBusy,
+    AudioHardware,
+    Network,
+    SynthesisUnavailable,
+    SynthesisFailed,
+    LanguageUnavailable,
+    VoiceUnavailable,
+    TextTooLong,
+    InvalidArgument,
+    NotAllowed
+};
+
 enum class SpeechBoundary : uint8_t {
     SpeechWordBoundary,
     SpeechSentenceBoundary
@@ -51,7 +67,7 @@ class PlatformSpeechSynthesizerClient {
     virtual void didFinishSpeaking(PlatformSpeechSynthesisUtterance&) = 0;
     virtual void didPauseSpeaking(PlatformSpeechSynthesisUtterance&) = 0;
     virtual void didResumeSpeaking(PlatformSpeechSynthesisUtterance&) = 0;
-    virtual void speakingErrorOccurred(PlatformSpeechSynthesisUtterance&) = 0;
+    virtual void speakingErrorOccurred(PlatformSpeechSynthesisUtterance&, SpeechError) = 0;
     virtual void boundaryEventOccurred(PlatformSpeechSynthesisUtterance&, SpeechBoundary, unsigned charIndex, unsigned charLength) = 0;
     virtual void voicesDidChange() = 0;
 protected:
diff --git a/Source/WebCore/platform/mac/PlatformSpeechSynthesizerMac.mm b/Source/WebCore/platform/mac/PlatformSpeechSynthesizerMac.mm
@@ -160,7 +160,7 @@ - (void)cancel
         return;
 
     [m_synthesizer stopSpeakingAtBoundary:NSSpeechImmediateBoundary];
-    m_synthesizerObject->client()->speakingErrorOccurred(*m_utterance);
+    m_synthesizerObject->client()->speakingErrorOccurred(*m_utterance, WebCore::SpeechError::None);
     m_utterance = 0;
 }
 
@@ -185,7 +185,7 @@ - (void)speechSynthesizer:(NSSpeechSynthesizer *)sender didFinishSpeaking:(BOOL)
     if (finishedSpeaking)
         m_synthesizerObject->client()->didFinishSpeaking(*utterance);
     else
-        m_synthesizerObject->client()->speakingErrorOccurred(*utterance);
+        m_synthesizerObject->client()->speakingErrorOccurred(*utterance, WebCore::SpeechError::None);
 }
 
 - (void)speechSynthesizer:(NSSpeechSynthesizer *)sender willSpeakWord:(NSRange)characterRange ofString:(NSString *)string
diff --git a/Source/WebCore/platform/mock/PlatformSpeechSynthesizerMock.cpp b/Source/WebCore/platform/mock/PlatformSpeechSynthesizerMock.cpp
@@ -75,7 +75,7 @@ void PlatformSpeechSynthesizerMock::cancel()
         return;
 
     m_speakingFinishedTimer.stop();
-    client()->speakingErrorOccurred(*m_utterance);
+    client()->speakingErrorOccurred(*m_utterance, WebCore::SpeechError::Canceled);
     m_utterance = nullptr;
 }
 
diff --git a/Source/WebKit/UIProcess/WebPageProxy.cpp b/Source/WebKit/UIProcess/WebPageProxy.cpp
@@ -9715,7 +9715,7 @@ void WebPageProxy::didResumeSpeaking(WebCore::PlatformSpeechSynthesisUtterance&)
         speechSynthesisData().speakingResumedCompletionHandler();
 }
 
-void WebPageProxy::speakingErrorOccurred(WebCore::PlatformSpeechSynthesisUtterance&)
+void WebPageProxy::speakingErrorOccurred(WebCore::PlatformSpeechSynthesisUtterance&, WebCore::SpeechError)
 {
     send(Messages::WebPage::SpeakingErrorOccurred());
 }
diff --git a/Source/WebKit/UIProcess/WebPageProxy.h b/Source/WebKit/UIProcess/WebPageProxy.h
@@ -2225,7 +2225,7 @@ class WebPageProxy : public API::ObjectImpl<API::Object::Type::Page>
     void didFinishSpeaking(WebCore::PlatformSpeechSynthesisUtterance&) override;
     void didPauseSpeaking(WebCore::PlatformSpeechSynthesisUtterance&) override;
     void didResumeSpeaking(WebCore::PlatformSpeechSynthesisUtterance&) override;
-    void speakingErrorOccurred(WebCore::PlatformSpeechSynthesisUtterance&) override;
+    void speakingErrorOccurred(WebCore::PlatformSpeechSynthesisUtterance&, WebCore::SpeechError) override;
     void boundaryEventOccurred(WebCore::PlatformSpeechSynthesisUtterance&, WebCore::SpeechBoundary, unsigned charIndex, unsigned charLength) override;
     void voicesDidChange() override;
 

Original file line number	Diff line number	Diff line change
`@@ -160,7 +160,7 @@ - (void)cancel`
`160`	`160`	`return;`
`161`	`161`
`162`	`162`	`[m_synthesizer stopSpeakingAtBoundary:NSSpeechImmediateBoundary];`
`163`		`- m_synthesizerObject->client()->speakingErrorOccurred(*m_utterance);`
	`163`	`+ m_synthesizerObject->client()->speakingErrorOccurred(*m_utterance, WebCore::SpeechError::None);`
`164`	`164`	`m_utterance = 0;`
`165`	`165`	`}`
`166`	`166`
`@@ -185,7 +185,7 @@ - (void)speechSynthesizer:(NSSpeechSynthesizer *)sender didFinishSpeaking:(BOOL)`
`185`	`185`	`if (finishedSpeaking)`
`186`	`186`	`m_synthesizerObject->client()->didFinishSpeaking(*utterance);`
`187`	`187`	`else`
`188`		`- m_synthesizerObject->client()->speakingErrorOccurred(*utterance);`
	`188`	`+ m_synthesizerObject->client()->speakingErrorOccurred(*utterance, WebCore::SpeechError::None);`
`189`	`189`	`}`
`190`	`190`
`191`	`191`	`- (void)speechSynthesizer:(NSSpeechSynthesizer )sender willSpeakWord:(NSRange)characterRange ofString:(NSString )string`
Original file line number	Diff line number	Diff line change
`@@ -75,7 +75,7 @@ void PlatformSpeechSynthesizerMock::cancel()`
`75`	`75`	`return;`
`76`	`76`
`77`	`77`	`m_speakingFinishedTimer.stop();`
`78`		`- client()->speakingErrorOccurred(*m_utterance);`
	`78`	`+ client()->speakingErrorOccurred(*m_utterance, WebCore::SpeechError::Canceled);`
`79`	`79`	`m_utterance = nullptr;`
`80`	`80`	`}`
`81`	`81`
Original file line number	Diff line number	Diff line change
`@@ -9715,7 +9715,7 @@ void WebPageProxy::didResumeSpeaking(WebCore::PlatformSpeechSynthesisUtterance&)`
`9715`	`9715`	`speechSynthesisData().speakingResumedCompletionHandler();`
`9716`	`9716`	`}`
`9717`	`9717`
`9718`		`-void WebPageProxy::speakingErrorOccurred(WebCore::PlatformSpeechSynthesisUtterance&)`
	`9718`	`+void WebPageProxy::speakingErrorOccurred(WebCore::PlatformSpeechSynthesisUtterance&, WebCore::SpeechError)`
`9719`	`9719`	`{`
`9720`	`9720`	`send(Messages::WebPage::SpeakingErrorOccurred());`
`9721`	`9721`	`}`