qtmobility/src/multimedia/qmediarecorder.cpp
changeset 1 2b40d63a9c3d
child 4 90517678cc4f
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/qtmobility/src/multimedia/qmediarecorder.cpp	Fri Apr 16 15:51:22 2010 +0300
@@ -0,0 +1,567 @@
+/****************************************************************************
+**
+** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies).
+** All rights reserved.
+** Contact: Nokia Corporation (qt-info@nokia.com)
+**
+** This file is part of the Qt Mobility Components.
+**
+** $QT_BEGIN_LICENSE:LGPL$
+** No Commercial Usage
+** This file contains pre-release code and may not be distributed.
+** You may use this file in accordance with the terms and conditions
+** contained in the Technology Preview License Agreement accompanying
+** this package.
+**
+** 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, 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.
+**
+** If you have questions regarding the use of this file, please contact
+** Nokia at qt-info@nokia.com.
+**
+**
+**
+**
+**
+**
+**
+**
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+#include <qmediarecorder.h>
+
+#include <qmediarecordercontrol.h>
+#include <qmediaobject_p.h>
+#include <qmediaservice.h>
+#include <qmediaserviceprovider.h>
+#include <qaudioencodercontrol.h>
+#include <qvideoencodercontrol.h>
+#include <qmediacontainercontrol.h>
+
+#include <QtCore/qdebug.h>
+#include <QtCore/qurl.h>
+#include <QtCore/qstringlist.h>
+#include <QtCore/qmetaobject.h>
+
+#include <QtMultimedia/qaudioformat.h>
+
+QTM_BEGIN_NAMESPACE
+
+/*!
+    \class QMediaRecorder
+    \ingroup multimedia
+
+    \preliminary
+    \brief The QMediaRecorder class is used for the recording of media content.
+
+    The QMediaRecorder class is a high level media recording class.
+    It's not intended to be used alone but for accessing the media
+    recording functions of other media objects, like QRadioTuner,
+    or QAudioCaptureSource.
+
+    If the radio is used as a source, recording
+    is only possible when the source is in appropriate state
+
+    \code
+    // Audio only recording
+    audioSource = new QAudioCaptureSource;
+    recorder = new QMediaRecorder(audioSource);
+
+    QAudioEncoderSettings audioSettings;
+    audioSettings.setCodec("audio/vorbis");
+    audioSettings.setQuality(QtMedia::HighQuality);
+
+    recorder->setEncodingSettings(audioSettings);
+
+    recorder->setOutputLocation(QUrl::fromLocalFile(fileName));
+    recorder->record();
+    \endcode
+
+
+    \sa
+*/
+
+namespace
+{
+class MediaRecorderRegisterMetaTypes
+{
+public:
+    MediaRecorderRegisterMetaTypes()
+    {
+        qRegisterMetaType<QMediaRecorder::State>("QMediaRecorder::State");
+        qRegisterMetaType<QMediaRecorder::Error>("QMediaRecorder::Error");
+    }
+} _registerRecorderMetaTypes;
+}
+
+
+class QMediaRecorderPrivate : public QMediaObjectPrivate
+{
+    Q_DECLARE_NON_CONST_PUBLIC(QMediaRecorder)
+
+public:
+    QMediaRecorderPrivate();
+    void initControls();
+
+    QMediaRecorderControl *control;
+    QMediaContainerControl *formatControl;
+    QAudioEncoderControl *audioControl;
+    QVideoEncoderControl *videoControl;
+
+    QMediaRecorder::State state;
+    QMediaRecorder::Error error;
+    QString errorString;
+
+    void _q_stateChanged(QMediaRecorder::State state);
+    void _q_error(int error, const QString &errorString);
+};
+
+QMediaRecorderPrivate::QMediaRecorderPrivate():
+     control(0),
+     formatControl(0),
+     audioControl(0),
+     videoControl(0),
+     state(QMediaRecorder::StoppedState),
+     error(QMediaRecorder::NoError)
+{
+}
+
+void QMediaRecorderPrivate::initControls()
+{
+    Q_Q(QMediaRecorder);
+
+    if (!service)
+        return;
+
+    control = qobject_cast<QMediaRecorderControl*>(service->control(QMediaRecorderControl_iid));
+    formatControl = qobject_cast<QMediaContainerControl *>(service->control(QMediaContainerControl_iid));
+    audioControl = qobject_cast<QAudioEncoderControl *>(service->control(QAudioEncoderControl_iid));
+    videoControl = qobject_cast<QVideoEncoderControl *>(service->control(QVideoEncoderControl_iid));
+
+    if (control) {
+        q->connect(control, SIGNAL(stateChanged(QMediaRecorder::State)),
+                q, SLOT(_q_stateChanged(QMediaRecorder::State)));
+
+        q->connect(control, SIGNAL(error(int,QString)),
+                q, SLOT(_q_error(int,QString)));
+    }
+}
+
+#define ENUM_NAME(c,e,v) (c::staticMetaObject.enumerator(c::staticMetaObject.indexOfEnumerator(e)).valueToKey((v)))
+
+
+void QMediaRecorderPrivate::_q_stateChanged(QMediaRecorder::State ps)
+{
+    Q_Q(QMediaRecorder);
+
+    if (ps == QMediaRecorder::RecordingState)
+        q->addPropertyWatch("duration");
+    else
+        q->removePropertyWatch("duration");
+
+//    qDebug() << "Recorder state changed:" << ENUM_NAME(QMediaRecorder,"State",ps);
+    if (state != ps) {
+        emit q->stateChanged(ps);
+    }
+
+    state = ps;
+}
+
+
+void QMediaRecorderPrivate::_q_error(int error, const QString &errorString)
+{
+    Q_Q(QMediaRecorder);
+
+    this->error = QMediaRecorder::Error(error);
+    this->errorString = errorString;
+
+    emit q->error(this->error);
+}
+
+
+/*!
+    Constructs a media recorder which records the media produced by \a mediaObject.
+
+    The \a parent is passed to QMediaObject.
+*/
+
+QMediaRecorder::QMediaRecorder(QMediaObject *mediaObject, QObject *parent):
+    QMediaObject(*new QMediaRecorderPrivate, parent, mediaObject->service())
+{
+    Q_D(QMediaRecorder);
+
+    d->initControls();
+}
+
+/*!
+    Destroys a media recorder object.
+*/
+
+QMediaRecorder::~QMediaRecorder()
+{
+}
+
+/*!
+    \property QMediaRecorder::outputLocation
+    \brief the destination location of media content.
+
+    Setting the location can fail for example when the service supports
+    only local file system locations while the network url was passed,
+    or the service doesn't support media recording.
+*/
+
+/*!
+    Returns true if media recorder service ready to use.
+*/
+bool QMediaRecorder::isAvailable() const
+{
+    if (d_func()->control != NULL)
+        return true;
+    else
+        return false;
+}
+
+/*!
+    Returns the availability error code.
+*/
+QtMedia::AvailabilityError QMediaRecorder::availabilityError() const
+{
+    if (d_func()->control != NULL)
+        return QtMedia::NoError;
+    else
+        return QtMedia::ServiceMissingError;
+}
+
+QUrl QMediaRecorder::outputLocation() const
+{
+    return d_func()->control ? d_func()->control->outputLocation() : QUrl();
+}
+
+bool QMediaRecorder::setOutputLocation(const QUrl &location)
+{
+    Q_D(QMediaRecorder);
+    return d->control ? d->control->setOutputLocation(location) : false;
+}
+
+/*!
+    Returns the current media recorder state.
+
+    \sa QMediaRecorder::State
+*/
+
+QMediaRecorder::State QMediaRecorder::state() const
+{
+    return d_func()->control ? QMediaRecorder::State(d_func()->control->state()) : StoppedState;
+}
+
+/*!
+    Returns the current error state.
+
+    \sa errorString()
+*/
+
+QMediaRecorder::Error QMediaRecorder::error() const
+{
+    return d_func()->error;
+}
+
+/*!
+    Returns a string describing the current error state.
+
+    \sa error()
+*/
+
+QString QMediaRecorder::errorString() const
+{
+    return d_func()->errorString;
+}
+
+/*!
+    \property QMediaRecorder::duration
+
+    \brief the recorded media duration in milliseconds.
+*/
+
+qint64 QMediaRecorder::duration() const
+{
+    return d_func()->control ? d_func()->control->duration() : 0;
+}
+
+
+/*!
+    Returns a list of MIME types of supported container formats.
+*/
+QStringList QMediaRecorder::supportedContainers() const
+{
+    return d_func()->formatControl ?
+           d_func()->formatControl->supportedContainers() : QStringList();
+}
+
+/*!
+    Returns a description of a container format \a mimeType.
+*/
+QString QMediaRecorder::containerDescription(const QString &mimeType) const
+{
+    return d_func()->formatControl ?
+           d_func()->formatControl->containerDescription(mimeType) : QString();
+}
+
+/*!
+    Returns the MIME type of the selected container format.
+*/
+
+QString QMediaRecorder::containerMimeType() const
+{
+    return d_func()->formatControl ?
+           d_func()->formatControl->containerMimeType() : QString();
+}
+
+/*!
+    Returns a list of supported audio codecs.
+*/
+QStringList QMediaRecorder::supportedAudioCodecs() const
+{
+    return d_func()->audioControl ?
+           d_func()->audioControl->supportedAudioCodecs() : QStringList();
+}
+
+/*!
+    Returns a description of an audio \a codec.
+*/
+QString QMediaRecorder::audioCodecDescription(const QString &codec) const
+{
+    return d_func()->audioControl ?
+           d_func()->audioControl->codecDescription(codec) : QString();
+}
+
+/*!
+    Returns a list of supported audio sample rates.
+
+    If non null audio \a settings parameter is passed,
+    the returned list is reduced to sample rates supported with partial settings applied.
+
+    It can be used for example to query the list of sample rates, supported by specific audio codec.
+
+    If the encoder supports arbitrary sample rates within the supported rates range,
+    *\a continuous is set to true, otherwise *\a continuous is set to false.
+*/
+
+QList<int> QMediaRecorder::supportedAudioSampleRates(const QAudioEncoderSettings &settings, bool *continuous) const
+{
+    if (continuous)
+        *continuous = false;
+
+    return d_func()->audioControl ?
+           d_func()->audioControl->supportedSampleRates(settings, continuous) : QList<int>();
+}
+
+/*!
+    Returns a list of resolutions video can be encoded at.
+
+    If non null video \a settings parameter is passed,
+    the returned list is reduced to resolution supported with partial settings like video codec or framerate applied.
+
+    If the encoder supports arbitrary resolutions within the supported range,
+    *\a continuous is set to true, otherwise *\a continuous is set to false.
+
+    \sa QVideoEncoderSettings::resolution()
+*/
+QList<QSize> QMediaRecorder::supportedResolutions(const QVideoEncoderSettings &settings, bool *continuous) const
+{
+    if (continuous)
+        *continuous = false;
+
+    return d_func()->videoControl ?
+           d_func()->videoControl->supportedResolutions(settings, continuous) : QList<QSize>();
+}
+
+/*!
+    Returns a list of frame rates video can be encoded at.
+
+    If non null video \a settings parameter is passed,
+    the returned list is reduced to frame rates supported with partial settings like video codec or resolution applied.
+
+    If the encoder supports arbitrary frame rates within the supported range,
+    *\a continuous is set to true, otherwise *\a continuous is set to false.
+
+    \sa QVideoEncoderSettings::frameRate()
+*/
+QList<qreal> QMediaRecorder::supportedFrameRates(const QVideoEncoderSettings &settings, bool *continuous) const
+{
+    if (continuous)
+        *continuous = false;
+
+    return d_func()->videoControl ?
+           d_func()->videoControl->supportedFrameRates(settings, continuous) : QList<qreal>();
+}
+
+/*!
+    Returns a list of supported video codecs.
+*/
+QStringList QMediaRecorder::supportedVideoCodecs() const
+{
+    return d_func()->videoControl ?
+           d_func()->videoControl->supportedVideoCodecs() : QStringList();
+}
+
+/*!
+    Returns a description of a video \a codec.
+
+    \sa setEncodingSettings()
+*/
+QString QMediaRecorder::videoCodecDescription(const QString &codec) const
+{
+    return d_func()->videoControl ?
+           d_func()->videoControl->videoCodecDescription(codec) : QString();
+}
+
+/*!
+    Returns the audio encoder settings being used.
+
+    \sa setEncodingSettings()
+*/
+
+QAudioEncoderSettings QMediaRecorder::audioSettings() const
+{
+    return d_func()->audioControl ?
+           d_func()->audioControl->audioSettings() : QAudioEncoderSettings();
+}
+
+/*!
+    Returns the video encoder settings being used.
+
+    \sa setEncodingSettings()
+*/
+
+QVideoEncoderSettings QMediaRecorder::videoSettings() const
+{
+    return d_func()->videoControl ?
+           d_func()->videoControl->videoSettings() : QVideoEncoderSettings();
+}
+
+/*!
+    Sets the \a audio and \a video encoder settings and \a container format MIME type.
+
+    It's only possible to change setttings when the encoder
+    is in the QMediaEncoder::StoppedState state.
+
+    If some parameters are not specified, or null settings are passed,
+    the encoder choose the default encoding parameters, depending on
+    media source properties.
+    But while setEncodingSettings is optional, the backend can preload
+    encoding pipeline to improve recording startup time.
+
+    \sa audioSettings(), videoSettings(), containerMimeType()
+*/
+
+void QMediaRecorder::setEncodingSettings(const QAudioEncoderSettings &audio,
+                                         const QVideoEncoderSettings &video,
+                                         const QString &container)
+{
+    Q_D(QMediaRecorder);
+
+    if (d->audioControl)
+        d->audioControl->setAudioSettings(audio);
+
+    if (d->videoControl)
+        d->videoControl->setVideoSettings(video);
+
+    if (d->formatControl)
+        d->formatControl->setContainerMimeType(container);
+
+    if (d->control)
+        d->control->applySettings();
+}
+
+
+/*!
+    Start recording.
+
+    This is an asynchronous call, with signal
+    stateCahnged(QMediaRecorder::RecordingState) being emited
+    when recording started, otherwise error() signal is emited.
+*/
+
+void QMediaRecorder::record()
+{
+    Q_D(QMediaRecorder);
+
+    // reset error
+    d->error = NoError;
+    d->errorString = QString();
+
+    if (d->control)
+        d->control->record();
+}
+
+/*!
+    Pause recording.
+*/
+
+void QMediaRecorder::pause()
+{
+    Q_D(QMediaRecorder);
+    if (d->control)
+        d->control->pause();
+}
+
+/*!
+    Stop recording.
+*/
+
+void QMediaRecorder::stop()
+{
+    Q_D(QMediaRecorder);
+    if (d->control)
+        d->control->stop();
+}
+
+/*!
+    \enum QMediaRecorder::State
+
+    \value StoppedState    The recorder is not active.
+    \value RecordingState  The recorder is currently active and producing data.
+    \value PausedState     The recorder is paused.
+*/
+
+/*!
+    \enum QMediaRecorder::Error
+
+    \value NoError         No Errors.
+    \value ResourceError   Device is not ready or not available.
+    \value FormatError     Current format is not supported.
+*/
+
+/*!
+    \fn QMediaRecorder::stateChanged(State state)
+
+    Signals that a media recorder's \a state has changed.
+*/
+
+/*!
+    \fn QMediaRecorder::durationChanged(qint64 duration)
+
+    Signals that the \a duration of the recorded media has changed.
+*/
+
+/*!
+    \fn QMediaRecorder::error(QMediaRecorder::Error error)
+
+    Signals that an \a error has occurred.
+*/
+
+
+#include "moc_qmediarecorder.cpp"
+QTM_END_NAMESPACE
+