Add background audio element.

Change-Id: I64c91beb7219cc148efc606e87e5f6e57b4b55ce
Reviewed-on: http://codereview.qt.nokia.com/3574
Reviewed-by: Qt Sanity Bot <qt_sanity_bot@ovi.com>
Reviewed-by: Michael Goddard <michael.goddard@nokia.com>

src/imports/multimedia/multimedia.cpp

@@ -49,6 +49,7 @@
 #include "qdeclarativeaudio_p.h"
 #include "qdeclarativevideooutput_p.h"
 #include "qdeclarativeradio_p.h"
+#include "qdeclarativebackgroundaudio_p.h"
 #if 0
 #include "qdeclarativecamera_p.h"
 #include "qdeclarativecamerapreviewprovider_p.h"
@@ -71,6 +72,7 @@ public:
         qmlRegisterType<QDeclarativeAudio>(uri, 4, 0, "MediaPlayer");
         qmlRegisterType<QDeclarativeVideoOutput>(uri, 4, 0, "VideoOutput");
         qmlRegisterType<QDeclarativeRadio>(uri, 4, 0, "Radio");
+        qmlRegisterType<QDeclarativeBackgroundAudio>(uri, 4, 0, "BackgroundAudio");
         /* Disabled until ported to scenegraph */
 #if 0
         qmlRegisterType<QDeclarativeCamera>(uri, 4, 0, "Camera");

src/imports/multimedia/multimedia.pro

@@ -16,7 +16,8 @@ HEADERS += \
         qsgvideonode_p.h \
         qsgvideonode_i420.h \
         qsgvideonode_rgb32.h \
-        qdeclarativeradio_p.h
+        qdeclarativeradio_p.h \
+        qdeclarativebackgroundaudio_p.h
 
 SOURCES += \
         multimedia.cpp \
@@ -26,7 +27,8 @@ SOURCES += \
         qsgvideonode.cpp \
         qsgvideonode_i420.cpp \
         qsgvideonode_rgb32.cpp \
-        qdeclarativeradio.cpp
+        qdeclarativeradio.cpp \
+        qdeclarativebackgroundaudio.cpp
 
 disabled {
     HEADERS += \

src/imports/multimedia/qdeclarativebackgroundaudio.cpp

@@ -0,0 +1,137 @@
+/****************************************************************************
+**
+** Copyright (C) 2011 Nokia Corporation and/or its subsidiary(-ies).
+** All rights reserved.
+** Contact: Nokia Corporation (qt-info@nokia.com)
+**
+** This file is part of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:LGPL$
+** GNU Lesser General Public License Usage
+** 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, Nokia gives you certain additional
+** rights. These rights are described in the Nokia 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.
+**
+** Other Usage
+** Alternatively, this file may be used in accordance with the terms and
+** conditions contained in a signed written agreement between you and Nokia.
+**
+**
+**
+**
+**
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+#include "qdeclarativebackgroundaudio_p.h"
+#include <qmediabackgroundplaybackcontrol.h>
+#include <qmediaservice.h>
+
+void QDeclarativeBackgroundAudio::classBegin()
+{
+}
+
+void QDeclarativeBackgroundAudio::componentComplete()
+{
+    setObject(this, QMediaServiceProviderHint(QMediaServiceProviderHint::BackgroundPlayback));
+    if (m_mediaService) {
+        m_backgroundPlaybackControl =
+                static_cast<QMediaBackgroundPlaybackControl*>(
+                        m_mediaService->requestControl(QMediaBackgroundPlaybackControl_iid));
+        if (m_backgroundPlaybackControl) {
+            connect(m_backgroundPlaybackControl, SIGNAL(acquired()), this, SIGNAL(acquiredChanged()));
+            connect(m_backgroundPlaybackControl, SIGNAL(lost()), this, SIGNAL(acquiredChanged()));
+            if (!m_contextId.isEmpty())
+                m_backgroundPlaybackControl->setContextId(m_contextId);
+        } else {
+            qWarning("can not get QMediaBackgroundPlaybackControl!");
+        }
+    }
+    QDeclarativeMediaBase::componentComplete();
+}
+
+QDeclarativeBackgroundAudio::QDeclarativeBackgroundAudio(QObject *parent)
+    : QDeclarativeAudio(parent)
+    , m_backgroundPlaybackControl(0)
+{
+
+}
+
+QDeclarativeBackgroundAudio::~QDeclarativeBackgroundAudio()
+{
+    if (m_backgroundPlaybackControl)
+        m_mediaService->releaseControl(m_backgroundPlaybackControl);
+}
+
+/*!
+    \qmlproperty string BackgroundAudio::contextId
+
+    This property holds the unique contextId for the application
+
+    When a new contextId is set, the previously set contextId will be released automatically.
+*/
+QString QDeclarativeBackgroundAudio::contextId() const
+{
+    return m_contextId;
+}
+
+void QDeclarativeBackgroundAudio::setContextId(QString contextId)
+{
+    if (m_contextId == contextId)
+        return;
+    m_contextId = contextId;
+    if (m_backgroundPlaybackControl)
+        m_backgroundPlaybackControl->setContextId(m_contextId);
+    emit contextIdChanged();
+}
+
+/*!
+    \qmlproperty bool BackgroundAudio::acquired
+
+    This property indicates whether the application holds the playback resource in music daemon
+*/
+bool QDeclarativeBackgroundAudio::isAcquired() const
+{
+    if (!m_backgroundPlaybackControl)
+        return false;
+    return m_backgroundPlaybackControl->isAcquired();
+}
+
+/*!
+    \qmlmethod BackgroundAudio::acquire()
+
+    try to acquire the playback resource in music daemon
+*/
+void QDeclarativeBackgroundAudio::acquire()
+{
+    if (isAcquired() || !m_backgroundPlaybackControl)
+        return;
+    m_backgroundPlaybackControl->acquire();
+}
+
+/*!
+    \qmlmethod BackgroundAudio::acquire()
+
+    try to release the playback resource in music daemon
+*/
+void QDeclarativeBackgroundAudio::release()
+{
+    if (!isAcquired() || !m_backgroundPlaybackControl)
+        return;
+    m_backgroundPlaybackControl->release();
+}

src/imports/multimedia/qdeclarativebackgroundaudio_p.h

@@ -0,0 +1,97 @@
+/****************************************************************************
+**
+** Copyright (C) 2011 Nokia Corporation and/or its subsidiary(-ies).
+** All rights reserved.
+** Contact: Nokia Corporation (qt-info@nokia.com)
+**
+** This file is part of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:LGPL$
+** GNU Lesser General Public License Usage
+** 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, Nokia gives you certain additional
+** rights. These rights are described in the Nokia 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.
+**
+** Other Usage
+** Alternatively, this file may be used in accordance with the terms and
+** conditions contained in a signed written agreement between you and Nokia.
+**
+**
+**
+**
+**
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+#ifndef QDECLARATIVEBACKGROUNDAUDIO_P_H
+#define QDECLARATIVEBACKGROUNDAUDIO_P_H
+//
+//  W A R N I N G
+//  -------------
+//
+// This file is not part of the Qt API.  It exists for the convenience
+// of other Qt classes.  This header file may change from version to
+// version without notice, or even be removed.
+//
+// We mean it.
+//
+
+#include "qdeclarativeaudio_p.h"
+
+QT_BEGIN_HEADER
+
+QT_BEGIN_NAMESPACE
+
+class QMediaBackgroundPlaybackControl;
+class QDeclarativeBackgroundAudio : public QDeclarativeAudio
+{
+    Q_OBJECT
+    Q_PROPERTY(QString contextId READ contextId WRITE setContextId NOTIFY contextIdChanged)
+    Q_PROPERTY(bool acquired READ isAcquired NOTIFY acquiredChanged)
+public:
+    QDeclarativeBackgroundAudio(QObject *parent = 0);
+    ~QDeclarativeBackgroundAudio();
+
+    void classBegin();
+    void componentComplete();
+
+    QString contextId() const;
+    void setContextId(QString contextId);
+    bool isAcquired() const;
+
+public Q_SLOTS:
+    void acquire();
+    void release();
+
+Q_SIGNALS:
+    void contextIdChanged();
+    void acquiredChanged();
+
+private:
+    Q_DISABLE_COPY(QDeclarativeBackgroundAudio)
+    QString m_contextId;
+    QMediaBackgroundPlaybackControl *m_backgroundPlaybackControl;
+};
+
+QT_END_NAMESPACE
+
+QML_DECLARE_TYPE(QT_PREPEND_NAMESPACE(QDeclarativeBackgroundAudio))
+
+QT_END_HEADER
+
+#endif // QDECLARATIVEBACKGROUNDAUDIO_P_H

src/imports/multimedia/qdeclarativemediabase.cpp

@@ -260,12 +260,13 @@ void QDeclarativeMediaBase::shutdown()
 
 }
 
-void QDeclarativeMediaBase::setObject(QObject *object)
+void QDeclarativeMediaBase::setObject(QObject *object, const QMediaServiceProviderHint& hint)
 {
     m_qmlObject = object;
 
     if ((m_mediaProvider = QMediaServiceProvider::defaultServiceProvider()) != 0) {
-        if ((m_mediaService = m_mediaProvider->requestService(Q_MEDIASERVICE_MEDIAPLAYER)) != 0) {
+        m_mediaService = m_mediaProvider->requestService(Q_MEDIASERVICE_MEDIAPLAYER, hint);
+        if (m_mediaService != 0) {
             m_playerControl = qobject_cast<QMediaPlayerControl *>(
                     m_mediaService->requestControl(QMediaPlayerControl_iid));
             m_metaDataControl = qobject_cast<QMetaDataReaderControl *>(

src/imports/multimedia/qdeclarativemediabase_p.h

@@ -123,7 +123,7 @@ public:
 protected:
     void shutdown();
 
-    void setObject(QObject *object);
+    void setObject(QObject *object, const QMediaServiceProviderHint& hint = QMediaServiceProviderHint());
 
     virtual void sourceChanged() = 0;
     virtual void autoLoadChanged() = 0;