Add support for checking if audio is played in a page.

Add support for checking if audio is played in a page, as well
as the ability to (un)mute the audio.

Modify demobrowser example to show (muted) in the tab title, if
the tab is muted, or (audible) if there is audio playing in the tab.
Fix HTML5 audio/video (un)mute to also work.

Change-Id: I7213645e67be2f9da1c5f96cdf6c7eef5341ae4b
Task-number: QTBUG-48788
Reviewed-by: Allan Sandfeld Jensen <allan.jensen@theqtcompany.com>

4 files changed, 77 insertions, 1 deletions

diff --git a/src/webenginewidgets/api/qwebenginepage.cpp b/src/webenginewidgets/api/qwebenginepage.cpp
index ee5702309..ec98a8346 100644
--- a/src/webenginewidgets/api/qwebenginepage.cpp
+++ b/src/webenginewidgets/api/qwebenginepage.cpp
@@ -146,6 +146,12 @@ void QWebEnginePagePrivate::selectionChanged()
     Q_EMIT q->selectionChanged();
 }
 
+void QWebEnginePagePrivate::wasRecentlyAudibleChanged(bool wasRecentlyAudible)
+{
+    Q_Q(QWebEnginePage);
+    Q_EMIT q->wasRecentlyAudibleChanged(wasRecentlyAudible);
+}
+
 QRectF QWebEnginePagePrivate::viewportRect() const
 {
     return view ? view->rect() : QRectF();
@@ -570,6 +576,33 @@ void QWebEnginePage::setBackgroundColor(const QColor &color)
     d->adapter->backgroundColorChanged();
 }
 
+/*!
+    \property QWebEnginePage::audioMuted
+    \brief the state of whether the current page audio is muted.
+    \since 5.7
+
+    The default value is false.
+*/
+bool QWebEnginePage::isAudioMuted() const {
+    const Q_D(QWebEnginePage);
+    return d->adapter->isAudioMuted();
+}
+
+void QWebEnginePage::setAudioMuted(bool muted) {
+    Q_D(QWebEnginePage);
+    bool _isAudioMuted = isAudioMuted();
+    d->adapter->setAudioMuted(muted);
+    if (_isAudioMuted != muted) {
+        Q_EMIT audioMutedChanged(muted);
+    }
+}
+
+bool QWebEnginePage::wasRecentlyAudible()
+{
+    Q_D(QWebEnginePage);
+    return d->adapter->wasRecentlyAudible();
+}
+
 void QWebEnginePage::setView(QWidget *view)
 {
     QWebEngineViewPrivate::bind(qobject_cast<QWebEngineView*>(view), this);
@@ -873,7 +906,8 @@ void QWebEnginePage::triggerAction(WebAction action, bool)
         break;
     case ToggleMediaMute:
         if (d->m_menuData.mediaUrl.isValid() && d->m_menuData.mediaFlags & WebEngineContextMenuData::MediaHasAudio) {
-            bool enable = (d->m_menuData.mediaFlags & WebEngineContextMenuData::MediaMuted);
+            // Make sure to negate the value, so that toggling actually works.
+            bool enable = !(d->m_menuData.mediaFlags & WebEngineContextMenuData::MediaMuted);
             d->adapter->executeMediaPlayerActionAt(d->m_menuData.pos, WebContentsAdapter::MediaPlayerMute, enable);
         }
         break;
diff --git a/src/webenginewidgets/api/qwebenginepage.h b/src/webenginewidgets/api/qwebenginepage.h
index b3c592708..7c9495199 100644
--- a/src/webenginewidgets/api/qwebenginepage.h
+++ b/src/webenginewidgets/api/qwebenginepage.h
@@ -72,6 +72,7 @@ class QWEBENGINEWIDGETS_EXPORT QWebEnginePage : public QObject {
     Q_PROPERTY(QColor backgroundColor READ backgroundColor WRITE setBackgroundColor)
     Q_PROPERTY(QSizeF contentsSize READ contentsSize NOTIFY contentsSizeChanged)
     Q_PROPERTY(QPointF scrollPosition READ scrollPosition NOTIFY scrollPositionChanged)
+    Q_PROPERTY(bool audioMuted READ isAudioMuted WRITE setAudioMuted NOTIFY audioMutedChanged)
 
 public:
     enum WebAction {
@@ -247,6 +248,10 @@ public:
     QColor backgroundColor() const;
     void setBackgroundColor(const QColor &color);
 
+    bool isAudioMuted() const;
+    void setAudioMuted(bool muted);
+    bool wasRecentlyAudible();
+
 Q_SIGNALS:
     void loadStarted();
     void loadProgress(int progress);
@@ -274,6 +279,8 @@ Q_SIGNALS:
 
     void scrollPositionChanged(const QPointF &position);
     void contentsSizeChanged(const QSizeF &size);
+    void audioMutedChanged(bool muted);
+    void wasRecentlyAudibleChanged(bool wasRecentlyAudible);
 
 protected:
     virtual QWebEnginePage *createWindow(WebWindowType type);
diff --git a/src/webenginewidgets/api/qwebenginepage_p.h b/src/webenginewidgets/api/qwebenginepage_p.h
index 6f1341054..2ec5f6288 100644
--- a/src/webenginewidgets/api/qwebenginepage_p.h
+++ b/src/webenginewidgets/api/qwebenginepage_p.h
@@ -84,6 +84,7 @@ public:
     virtual void loadProgressChanged(int progress) Q_DECL_OVERRIDE;
     virtual void didUpdateTargetURL(const QUrl&) Q_DECL_OVERRIDE;
     virtual void selectionChanged() Q_DECL_OVERRIDE;
+    virtual void wasRecentlyAudibleChanged(bool wasRecentlyAudible) Q_DECL_OVERRIDE;
     virtual QRectF viewportRect() const Q_DECL_OVERRIDE;
     virtual qreal dpiScale() const Q_DECL_OVERRIDE;
     virtual QColor backgroundColor() const Q_DECL_OVERRIDE;
diff --git a/src/webenginewidgets/doc/src/qwebenginepage_lgpl.qdoc b/src/webenginewidgets/doc/src/qwebenginepage_lgpl.qdoc
index d3c540016..e09561bef 100644
--- a/src/webenginewidgets/doc/src/qwebenginepage_lgpl.qdoc
+++ b/src/webenginewidgets/doc/src/qwebenginepage_lgpl.qdoc
@@ -690,3 +690,37 @@
 
     \sa iconUrl()
 */
+
+/*!
+    \property QWebEnginePage::audioMuted
+    \brief the state of whether the current page audio is muted.
+    \since 5.7
+*/
+
+/*!
+    \fn void QWebEnginePage::audioMutedChanged(bool muted)
+    \since 5.7
+
+    This signal is emitted when the page's audio is (un)muted using setAudioMuted method.
+    \note Not to be confused with a specific HTML5 audio / video element being muted.
+*/
+
+/*!
+    \fn bool QWebEnginePage::wasRecentlyAudible()
+    \since 5.7
+    \sa wasRecentlyAudibleChanged()
+
+    Returns the current page's audible state (audio was recently played, or not).
+*/
+
+/*!
+    \fn void QWebEnginePage::wasRecentlyAudibleChanged(bool wasRecentlyAudible);
+    \since 5.7
+
+    This signal is emitted when the page's audible state is changed, due to audio
+    being played or stopped.
+
+    \note The signal is also emitted when calling the setAudioMuted method.
+    Also if the audio is paused, this signal is emitted with an approximate \b{2 second
+    delay}, from the moment the audio is paused.
+*/