AVFoundation: Add QVideoWindowControl support

This adds the capability to render videos directly to native
window surfaces when using the AVFoundation plugin.  This adds limited
support for displaying videos from QML on iOS.  These videos are
displayed in a CALayer above the QQuickWindow, so it will not be
possible to render any QtQuick items on top of a video using the
QVideoWindowControl to provide video.

[ChangeLog][QtMultimedia][iOS] Add limited support for playing videos in
QtQuick on iOS (Videos are played on top of scene with limited transform
support).

Change-Id: I80381d9a07b45b6fa1959678166e6da0004f8c19
Reviewed-by: Yoann Lopes <yoann.lopes@digia.com>

4 files changed, 378 insertions, 2 deletions

diff --git a/src/plugins/avfoundation/mediaplayer/avfmediaplayerservice.mm b/src/plugins/avfoundation/mediaplayer/avfmediaplayerservice.mm
index 398f00e2f..e5549803f 100644
--- a/src/plugins/avfoundation/mediaplayer/avfmediaplayerservice.mm
+++ b/src/plugins/avfoundation/mediaplayer/avfmediaplayerservice.mm
@@ -50,6 +50,7 @@
 #ifndef QT_NO_WIDGETS
 # include "avfvideowidgetcontrol.h"
 #endif
+#include "avfvideowindowcontrol.h"
 
 QT_USE_NAMESPACE
 
@@ -102,6 +103,13 @@ QMediaControl *AVFMediaPlayerService::requestControl(const char *name)
         return m_videoOutput;
     }
 #endif
+    if (qstrcmp(name, QVideoWindowControl_iid) == 0) {
+        if (!m_videoOutput)
+            m_videoOutput = new AVFVideoWindowControl(this);
+
+        m_session->setVideoOutput(qobject_cast<AVFVideoOutput*>(m_videoOutput));
+        return m_videoOutput;
+    }
     return 0;
 }
 
diff --git a/src/plugins/avfoundation/mediaplayer/avfvideowindowcontrol.h b/src/plugins/avfoundation/mediaplayer/avfvideowindowcontrol.h
new file mode 100644
index 000000000..9ea87058d
--- /dev/null
+++ b/src/plugins/avfoundation/mediaplayer/avfvideowindowcontrol.h
@@ -0,0 +1,120 @@
+/****************************************************************************
+**
+** Copyright (C) 2014 Digia Plc and/or its subsidiary(-ies).
+** Contact: http://www.qt-project.org/legal
+**
+** This file is part of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:LGPL$
+** Commercial License Usage
+** Licensees holding valid commercial Qt licenses may use this file in
+** accordance with the commercial license agreement provided with the
+** Software or, alternatively, in accordance with the terms contained in
+** a written agreement between you and Digia.  For licensing terms and
+** conditions see http://qt.digia.com/licensing.  For further information
+** use the contact form at http://qt.digia.com/contact-us.
+**
+** GNU Lesser General Public License Usage
+** Alternatively, this file may be used under the terms of the GNU Lesser
+** General Public License version 2.1 as published by the Free Software
+** Foundation and appearing in the file LICENSE.LGPL included in the
+** packaging of this file.  Please review the following information to
+** ensure the GNU Lesser General Public License version 2.1 requirements
+** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
+**
+** In addition, as a special exception, Digia gives you certain additional
+** rights.  These rights are described in the Digia Qt LGPL Exception
+** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
+**
+** GNU General Public License Usage
+** Alternatively, this file may be used under the terms of the GNU
+** General Public License version 3.0 as published by the Free Software
+** Foundation and appearing in the file LICENSE.GPL included in the
+** packaging of this file.  Please review the following information to
+** ensure the GNU General Public License version 3.0 requirements will be
+** met: http://www.gnu.org/copyleft/gpl.html.
+**
+**
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+#ifndef AVFVIDEOWINDOWCONTROL_H
+#define AVFVIDEOWINDOWCONTROL_H
+
+#include <QVideoWindowControl>
+
+@class AVPlayerLayer;
+#if defined(Q_OS_OSX)
+@class NSView;
+typedef NSView NativeView;
+#else
+@class UIView;
+typedef UIView NativeView;
+#endif
+
+#include "avfvideooutput.h"
+
+QT_BEGIN_NAMESPACE
+
+class AVFVideoWindowControl : public QVideoWindowControl, public AVFVideoOutput
+{
+    Q_OBJECT
+    Q_INTERFACES(AVFVideoOutput)
+
+public:
+    AVFVideoWindowControl(QObject *parent = 0);
+    virtual ~AVFVideoWindowControl();
+
+    // QVideoWindowControl interface
+public:
+    WId winId() const;
+    void setWinId(WId id);
+
+    QRect displayRect() const;
+    void setDisplayRect(const QRect &rect);
+
+    bool isFullScreen() const;
+    void setFullScreen(bool fullScreen);
+
+    void repaint();
+    QSize nativeSize() const;
+
+    Qt::AspectRatioMode aspectRatioMode() const;
+    void setAspectRatioMode(Qt::AspectRatioMode mode);
+
+    int brightness() const;
+    void setBrightness(int brightness);
+
+    int contrast() const;
+    void setContrast(int contrast);
+
+    int hue() const;
+    void setHue(int hue);
+
+    int saturation() const;
+    void setSaturation(int saturation);
+
+    // AVFVideoOutput interface
+    void setLayer(void *playerLayer);
+
+private:
+    void updateAspectRatio();
+    void updatePlayerLayerBounds();
+
+    WId m_winId;
+    QRect m_displayRect;
+    bool m_fullscreen;
+    int m_brightness;
+    int m_contrast;
+    int m_hue;
+    int m_saturation;
+    Qt::AspectRatioMode m_aspectRatioMode;
+    QSize m_nativeSize;
+    AVPlayerLayer *m_playerLayer;
+    NativeView *m_nativeView;
+};
+
+QT_END_NAMESPACE
+
+#endif // AVFVIDEOWINDOWCONTROL_H
diff --git a/src/plugins/avfoundation/mediaplayer/avfvideowindowcontrol.mm b/src/plugins/avfoundation/mediaplayer/avfvideowindowcontrol.mm
new file mode 100644
index 000000000..17fc94de7
--- /dev/null
+++ b/src/plugins/avfoundation/mediaplayer/avfvideowindowcontrol.mm
@@ -0,0 +1,246 @@
+/****************************************************************************
+**
+** Copyright (C) 2014 Digia Plc and/or its subsidiary(-ies).
+** Contact: http://www.qt-project.org/legal
+**
+** This file is part of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:LGPL$
+** Commercial License Usage
+** Licensees holding valid commercial Qt licenses may use this file in
+** accordance with the commercial license agreement provided with the
+** Software or, alternatively, in accordance with the terms contained in
+** a written agreement between you and Digia.  For licensing terms and
+** conditions see http://qt.digia.com/licensing.  For further information
+** use the contact form at http://qt.digia.com/contact-us.
+**
+** GNU Lesser General Public License Usage
+** Alternatively, this file may be used under the terms of the GNU Lesser
+** General Public License version 2.1 as published by the Free Software
+** Foundation and appearing in the file LICENSE.LGPL included in the
+** packaging of this file.  Please review the following information to
+** ensure the GNU Lesser General Public License version 2.1 requirements
+** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
+**
+** In addition, as a special exception, Digia gives you certain additional
+** rights.  These rights are described in the Digia Qt LGPL Exception
+** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
+**
+** GNU General Public License Usage
+** Alternatively, this file may be used under the terms of the GNU
+** General Public License version 3.0 as published by the Free Software
+** Foundation and appearing in the file LICENSE.GPL included in the
+** packaging of this file.  Please review the following information to
+** ensure the GNU General Public License version 3.0 requirements will be
+** met: http://www.gnu.org/copyleft/gpl.html.
+**
+**
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+#include "avfvideowindowcontrol.h"
+
+#include <AVFoundation/AVFoundation.h>
+
+QT_USE_NAMESPACE
+
+AVFVideoWindowControl::AVFVideoWindowControl(QObject *parent)
+    : QVideoWindowControl(parent)
+    , m_winId(0)
+    , m_fullscreen(false)
+    , m_brightness(0)
+    , m_contrast(0)
+    , m_hue(0)
+    , m_saturation(0)
+    , m_aspectRatioMode(Qt::IgnoreAspectRatio)
+    , m_playerLayer(0)
+    , m_nativeView(0)
+{
+}
+
+AVFVideoWindowControl::~AVFVideoWindowControl()
+{
+    if (m_playerLayer)
+        [m_playerLayer release];
+}
+
+WId AVFVideoWindowControl::winId() const
+{
+    return m_winId;
+}
+
+void AVFVideoWindowControl::setWinId(WId id)
+{
+    m_winId = id;
+    m_nativeView = (NativeView*)m_winId;
+}
+
+QRect AVFVideoWindowControl::displayRect() const
+{
+    return m_displayRect;
+}
+
+void AVFVideoWindowControl::setDisplayRect(const QRect &rect)
+{
+    if (m_displayRect != rect) {
+        m_displayRect = rect;
+        updatePlayerLayerBounds();
+    }
+}
+
+bool AVFVideoWindowControl::isFullScreen() const
+{
+    return m_fullscreen;
+}
+
+void AVFVideoWindowControl::setFullScreen(bool fullScreen)
+{
+    if (m_fullscreen != fullScreen) {
+        m_fullscreen = fullScreen;
+        Q_EMIT QVideoWindowControl::fullScreenChanged(fullScreen);
+    }
+}
+
+void AVFVideoWindowControl::repaint()
+{
+    if (m_playerLayer)
+        [m_playerLayer setNeedsDisplay];
+}
+
+QSize AVFVideoWindowControl::nativeSize() const
+{
+    return m_nativeSize;
+}
+
+Qt::AspectRatioMode AVFVideoWindowControl::aspectRatioMode() const
+{
+    return m_aspectRatioMode;
+}
+
+void AVFVideoWindowControl::setAspectRatioMode(Qt::AspectRatioMode mode)
+{
+    if (m_aspectRatioMode != mode) {
+        m_aspectRatioMode = mode;
+        updateAspectRatio();
+    }
+}
+
+int AVFVideoWindowControl::brightness() const
+{
+    return m_brightness;
+}
+
+void AVFVideoWindowControl::setBrightness(int brightness)
+{
+    if (m_brightness != brightness) {
+        m_brightness = brightness;
+        Q_EMIT QVideoWindowControl::brightnessChanged(brightness);
+    }
+}
+
+int AVFVideoWindowControl::contrast() const
+{
+    return m_contrast;
+}
+
+void AVFVideoWindowControl::setContrast(int contrast)
+{
+    if (m_contrast != contrast) {
+        m_contrast = contrast;
+        Q_EMIT QVideoWindowControl::contrastChanged(contrast);
+    }
+}
+
+int AVFVideoWindowControl::hue() const
+{
+    return m_hue;
+}
+
+void AVFVideoWindowControl::setHue(int hue)
+{
+    if (m_hue != hue) {
+        m_hue = hue;
+        Q_EMIT QVideoWindowControl::hueChanged(hue);
+    }
+}
+
+int AVFVideoWindowControl::saturation() const
+{
+    return m_saturation;
+}
+
+void AVFVideoWindowControl::setSaturation(int saturation)
+{
+    if (m_saturation != saturation) {
+        m_saturation = saturation;
+        Q_EMIT QVideoWindowControl::saturationChanged(saturation);
+    }
+}
+
+void AVFVideoWindowControl::setLayer(void *playerLayer)
+{
+    AVPlayerLayer *layer = (AVPlayerLayer*)playerLayer;
+    if (m_playerLayer == layer)
+        return;
+
+    if (!m_winId) {
+        qDebug("AVFVideoWindowControl: No video window");
+        return;
+    }
+
+#if defined(Q_OS_OSX)
+    [m_nativeView setWantsLayer:YES];
+#endif
+
+    if (m_playerLayer) {
+        [m_playerLayer removeFromSuperlayer];
+        [m_playerLayer release];
+    }
+
+    m_playerLayer = layer;
+
+    CALayer *nativeLayer = [m_nativeView layer];
+
+    if (layer) {
+        [layer retain];
+
+        m_nativeSize = QSize(m_playerLayer.bounds.size.width,
+                             m_playerLayer.bounds.size.height);
+
+        updateAspectRatio();
+        [nativeLayer addSublayer:m_playerLayer];
+        updatePlayerLayerBounds();
+    }
+}
+
+void AVFVideoWindowControl::updateAspectRatio()
+{
+    if (m_playerLayer) {
+        switch (m_aspectRatioMode) {
+        case Qt::IgnoreAspectRatio:
+            [m_playerLayer setVideoGravity:AVLayerVideoGravityResize];
+            break;
+        case Qt::KeepAspectRatio:
+            [m_playerLayer setVideoGravity:AVLayerVideoGravityResizeAspect];
+            break;
+        case Qt::KeepAspectRatioByExpanding:
+            [m_playerLayer setVideoGravity:AVLayerVideoGravityResizeAspectFill];
+            break;
+        default:
+            break;
+        }
+    }
+}
+
+void AVFVideoWindowControl::updatePlayerLayerBounds()
+{
+    if (m_playerLayer) {
+        CGRect newBounds = CGRectMake(0, 0,
+                                      m_displayRect.width(), m_displayRect.height());
+        m_playerLayer.bounds = newBounds;
+        m_playerLayer.position = CGPointMake(m_displayRect.x(), m_displayRect.y());
+    }
+}
+
+#include "moc_avfvideowindowcontrol.cpp"
diff --git a/src/plugins/avfoundation/mediaplayer/mediaplayer.pro b/src/plugins/avfoundation/mediaplayer/mediaplayer.pro
index e5bccd150..b5193b73d 100644
--- a/src/plugins/avfoundation/mediaplayer/mediaplayer.pro
+++ b/src/plugins/avfoundation/mediaplayer/mediaplayer.pro
@@ -21,7 +21,8 @@ HEADERS += \
     avfmediaplayerservice.h \
     avfmediaplayersession.h \
     avfmediaplayerserviceplugin.h \
-    avfvideooutput.h
+    avfvideooutput.h \
+    avfvideowindowcontrol.h
 
 OBJECTIVE_SOURCES += \
     avfmediaplayercontrol.mm \
@@ -29,7 +30,8 @@ OBJECTIVE_SOURCES += \
     avfmediaplayerservice.mm \
     avfmediaplayerserviceplugin.mm \
     avfmediaplayersession.mm \
-    avfvideooutput.mm
+    avfvideooutput.mm \
+    avfvideowindowcontrol.mm
 
     qtHaveModule(widgets) {
         QT += multimediawidgets-private