blob: 79412b961625ab9de5f475750204aeaaeda37429 [file] [log] [blame]
/****************************************************************************
**
** Copyright (C) 2016 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** 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 The Qt Company. For licensing terms
** and conditions see https://www.qt.io/terms-conditions. For further
** information use the contact form at https://www.qt.io/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 3 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPL3 included in the
** packaging of this file. Please review the following information to
** ensure the GNU Lesser General Public License version 3 requirements
** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 2.0 or (at your option) the GNU General
** Public license version 3 or any later version approved by the KDE Free
** Qt Foundation. The licenses are as published by the Free Software
** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
** included in the packaging of this file. Please review the following
** information to ensure the GNU General Public License requirements will
** be met: https://www.gnu.org/licenses/gpl-2.0.html and
** https://www.gnu.org/licenses/gpl-3.0.html.
**
** $QT_END_LICENSE$
**
****************************************************************************/
#include "qcamera_p.h"
#include "qmediaserviceprovider_p.h"
#include <qcamerainfo.h>
#include <qcameracontrol.h>
#include <qcameralockscontrol.h>
#include <qcameraexposurecontrol.h>
#include <qcamerafocuscontrol.h>
#include <qmediarecordercontrol.h>
#include <qcameraimageprocessingcontrol.h>
#include <qcameraimagecapturecontrol.h>
#include <qvideodeviceselectorcontrol.h>
#include <qcamerainfocontrol.h>
#include <qcameraviewfindersettingscontrol.h>
#include <QDebug>
QT_BEGIN_NAMESPACE
static void qRegisterCameraMetaTypes()
{
qRegisterMetaType<QCamera::Error>("QCamera::Error");
qRegisterMetaType<QCamera::State>("QCamera::State");
qRegisterMetaType<QCamera::Status>("QCamera::Status");
qRegisterMetaType<QCamera::CaptureModes>("QCamera::CaptureModes");
qRegisterMetaType<QCamera::LockType>("QCamera::LockType");
qRegisterMetaType<QCamera::LockStatus>("QCamera::LockStatus");
qRegisterMetaType<QCamera::LockChangeReason>("QCamera::LockChangeReason");
qRegisterMetaType<QCamera::Position>("QCamera::Position");
}
Q_CONSTRUCTOR_FUNCTION(qRegisterCameraMetaTypes)
Q_DECL_CONSTEXPR static bool qt_sizeLessThan(const QSize &s1, const QSize &s2) Q_DECL_NOTHROW
{
return (s1.width() * s1.height()) < (s2.width() * s2.height());
}
Q_DECL_CONSTEXPR static bool qt_frameRateRangeLessThan(const QCamera::FrameRateRange &s1, const QCamera::FrameRateRange &s2) Q_DECL_NOTHROW
{
return qFuzzyCompare(s1.maximumFrameRate, s2.maximumFrameRate) ? (s1.minimumFrameRate < s2.minimumFrameRate)
: (s1.maximumFrameRate < s2.maximumFrameRate);
}
/*!
\class QCamera
\brief The QCamera class provides interface for system camera devices.
\inmodule QtMultimedia
\ingroup multimedia
\ingroup multimedia_camera
QCamera can be used with QCameraViewfinder for viewfinder display,
QMediaRecorder for video recording and QCameraImageCapture for image taking.
You can use QCameraInfo to list available cameras and choose which one to use.
\snippet multimedia-snippets/camera.cpp Camera selection
See the \l{Camera Overview}{camera overview} for more information.
*/
void QCameraPrivate::_q_error(int error, const QString &errorString)
{
Q_Q(QCamera);
this->error = QCamera::Error(error);
this->errorString = errorString;
emit q->errorOccurred(this->error);
emit q->error(this->error);
}
void QCameraPrivate::setState(QCamera::State newState)
{
unsetError();
if (!control) {
_q_error(QCamera::ServiceMissingError, QCamera::tr("The camera service is missing"));
return;
}
restartPending = false;
control->setState(newState);
}
void QCameraPrivate::_q_updateState(QCamera::State newState)
{
Q_Q(QCamera);
//omit changins state to Loaded when the camera is temporarily
//stopped to apply shanges
if (restartPending)
return;
if (newState != state) {
state = newState;
emit q->stateChanged(state);
}
}
void QCameraPrivate::_q_preparePropertyChange(int changeType)
{
if (!control)
return;
QCamera::Status status = control->status();
//all the changes are allowed until the camera is starting
if (control->state() != QCamera::ActiveState)
return;
if (control->canChangeProperty(QCameraControl::PropertyChangeType(changeType), status))
return;
restartPending = true;
control->setState(QCamera::LoadedState);
QMetaObject::invokeMethod(q_ptr, "_q_restartCamera", Qt::QueuedConnection);
}
void QCameraPrivate::_q_restartCamera()
{
if (restartPending) {
restartPending = false;
control->setState(QCamera::ActiveState);
}
}
void QCameraPrivate::init()
{
Q_Q(QCamera);
provider = QMediaServiceProvider::defaultServiceProvider();
initControls();
cameraExposure = new QCameraExposure(q);
cameraFocus = new QCameraFocus(q);
imageProcessing = new QCameraImageProcessing(q);
}
void QCameraPrivate::initControls()
{
Q_Q(QCamera);
if (service) {
control = qobject_cast<QCameraControl *>(service->requestControl(QCameraControl_iid));
locksControl = qobject_cast<QCameraLocksControl *>(service->requestControl(QCameraLocksControl_iid));
deviceControl = qobject_cast<QVideoDeviceSelectorControl*>(service->requestControl(QVideoDeviceSelectorControl_iid));
infoControl = qobject_cast<QCameraInfoControl*>(service->requestControl(QCameraInfoControl_iid));
viewfinderSettingsControl2 = qobject_cast<QCameraViewfinderSettingsControl2*>(service->requestControl(QCameraViewfinderSettingsControl2_iid));
if (!viewfinderSettingsControl2)
viewfinderSettingsControl = qobject_cast<QCameraViewfinderSettingsControl*>(service->requestControl(QCameraViewfinderSettingsControl_iid));
if (control) {
q->connect(control, SIGNAL(stateChanged(QCamera::State)), q, SLOT(_q_updateState(QCamera::State)));
q->connect(control, SIGNAL(statusChanged(QCamera::Status)), q, SIGNAL(statusChanged(QCamera::Status)));
q->connect(control, SIGNAL(captureModeChanged(QCamera::CaptureModes)),
q, SIGNAL(captureModeChanged(QCamera::CaptureModes)));
q->connect(control, SIGNAL(error(int,QString)), q, SLOT(_q_error(int,QString)));
}
if (locksControl) {
q->connect(locksControl, SIGNAL(lockStatusChanged(QCamera::LockType,QCamera::LockStatus,QCamera::LockChangeReason)),
q, SLOT(_q_updateLockStatus(QCamera::LockType,QCamera::LockStatus,QCamera::LockChangeReason)));
}
error = QCamera::NoError;
} else {
control = nullptr;
locksControl = nullptr;
deviceControl = nullptr;
infoControl = nullptr;
viewfinderSettingsControl = nullptr;
viewfinderSettingsControl2 = nullptr;
error = QCamera::ServiceMissingError;
errorString = QCamera::tr("The camera service is missing");
}
}
void QCameraPrivate::clear()
{
delete cameraExposure;
delete cameraFocus;
delete imageProcessing;
if (service) {
if (control)
service->releaseControl(control);
if (locksControl)
service->releaseControl(locksControl);
if (deviceControl)
service->releaseControl(deviceControl);
if (infoControl)
service->releaseControl(infoControl);
if (viewfinderSettingsControl)
service->releaseControl(viewfinderSettingsControl);
if (viewfinderSettingsControl2)
service->releaseControl(viewfinderSettingsControl2);
provider->releaseService(service);
}
cameraExposure = nullptr;
cameraFocus = nullptr;
imageProcessing = nullptr;
control = nullptr;
locksControl = nullptr;
deviceControl = nullptr;
infoControl = nullptr;
viewfinderSettingsControl = nullptr;
viewfinderSettingsControl2 = nullptr;
service = nullptr;
}
void QCameraPrivate::updateLockStatus()
{
Q_Q(QCamera);
QCamera::LockStatus oldStatus = lockStatus;
QMap<QCamera::LockStatus, int> lockStatusPriority;
lockStatusPriority.insert(QCamera::Locked, 1);
lockStatusPriority.insert(QCamera::Unlocked, 2);
lockStatusPriority.insert(QCamera::Searching, 3);
lockStatus = requestedLocks ? QCamera::Locked : QCamera::Unlocked;
int priority = 0;
QList<QCamera::LockStatus> lockStatuses;
if (requestedLocks & QCamera::LockFocus)
lockStatuses << q->lockStatus(QCamera::LockFocus);
if (requestedLocks & QCamera::LockExposure)
lockStatuses << q->lockStatus(QCamera::LockExposure);
if (requestedLocks & QCamera::LockWhiteBalance)
lockStatuses << q->lockStatus(QCamera::LockWhiteBalance);
for (QCamera::LockStatus currentStatus : qAsConst(lockStatuses)) {
int currentPriority = lockStatusPriority.value(currentStatus, -1);
if (currentPriority > priority) {
priority = currentPriority;
lockStatus = currentStatus;
}
}
if (!supressLockChangedSignal && oldStatus != lockStatus) {
emit q->lockStatusChanged(lockStatus, lockChangeReason);
if (lockStatus == QCamera::Locked)
emit q->locked();
else if (lockStatus == QCamera::Unlocked && lockChangeReason == QCamera::LockFailed)
emit q->lockFailed();
}
/*
qDebug() << "Requested locks:" << (requestedLocks & QCamera::LockExposure ? 'e' : ' ')
<< (requestedLocks & QCamera::LockFocus ? 'f' : ' ')
<< (requestedLocks & QCamera::LockWhiteBalance ? 'w' : ' ');
qDebug() << "Lock status: f:" << q->lockStatus(QCamera::LockFocus)
<< " e:" << q->lockStatus(QCamera::LockExposure)
<< " w:" << q->lockStatus(QCamera::LockWhiteBalance)
<< " composite:" << lockStatus;
*/
}
void QCameraPrivate::_q_updateLockStatus(QCamera::LockType type, QCamera::LockStatus status, QCamera::LockChangeReason reason)
{
Q_Q(QCamera);
lockChangeReason = reason;
updateLockStatus();
emit q->lockStatusChanged(type, status, reason);
}
/*!
Construct a QCamera with a \a parent.
*/
QCamera::QCamera(QObject *parent):
QMediaObject(*new QCameraPrivate,
parent,
QMediaServiceProvider::defaultServiceProvider()->requestService(Q_MEDIASERVICE_CAMERA))
{
Q_D(QCamera);
d->init();
// Select the default camera
if (d->service != nullptr && d->deviceControl)
d->deviceControl->setSelectedDevice(d->deviceControl->defaultDevice());
}
/*!
Construct a QCamera from \a deviceName and \a parent.
If no camera with that \a deviceName exists, the camera object will
be invalid.
*/
QCamera::QCamera(const QByteArray& deviceName, QObject *parent):
QMediaObject(*new QCameraPrivate, parent,
QMediaServiceProvider::defaultServiceProvider()->requestService(Q_MEDIASERVICE_CAMERA,
QMediaServiceProviderHint(deviceName)))
{
Q_D(QCamera);
d->init();
bool found = false;
// Pass device name to service.
if (d->deviceControl) {
const QString name = QString::fromLatin1(deviceName);
for (int i = 0; i < d->deviceControl->deviceCount(); i++) {
if (d->deviceControl->deviceName(i) == name) {
d->deviceControl->setSelectedDevice(i);
found = true;
break;
}
}
}
// The camera should not be used if device with requested name does not exist.
if (!found) {
if (d->service) {
if (d->control)
d->service->releaseControl(d->control);
if (d->deviceControl)
d->service->releaseControl(d->deviceControl);
if (d->infoControl)
d->service->releaseControl(d->infoControl);
}
d->control = nullptr;
d->deviceControl = nullptr;
d->infoControl = nullptr;
d->error = QCamera::ServiceMissingError;
d->errorString = QCamera::tr("The camera service is missing");
}
}
/*!
\since 5.3
Construct a QCamera from a camera description \a cameraInfo and \a parent.
*/
QCamera::QCamera(const QCameraInfo &cameraInfo, QObject *parent)
: QCamera(cameraInfo.deviceName().toLatin1(), parent)
{
}
/*!
\since 5.3
Construct a QCamera which uses a hardware camera located a the specified \a position.
For example on a mobile phone it can be used to easily choose between front-facing and
back-facing cameras.
If no camera is available at the specified \a position or if \a position is
QCamera::UnspecifiedPosition, the default camera is used.
*/
QCamera::QCamera(QCamera::Position position, QObject *parent)
: QMediaObject(*new QCameraPrivate,
parent,
QMediaServiceProvider::defaultServiceProvider()->requestService(Q_MEDIASERVICE_CAMERA, QMediaServiceProviderHint(position)))
{
Q_D(QCamera);
d->init();
if (d->service != nullptr && d->deviceControl) {
bool selectDefault = true;
if (d->infoControl && position != UnspecifiedPosition) {
for (int i = 0; i < d->deviceControl->deviceCount(); i++) {
if (d->infoControl->cameraPosition(d->deviceControl->deviceName(i)) == position) {
d->deviceControl->setSelectedDevice(i);
selectDefault = false;
break;
}
}
}
if (selectDefault)
d->deviceControl->setSelectedDevice(d->deviceControl->defaultDevice());
}
}
/*!
Destroys the camera object.
*/
QCamera::~QCamera()
{
Q_D(QCamera);
d->clear();
}
/*!
Returns the availability state of the camera service.
*/
QMultimedia::AvailabilityStatus QCamera::availability() const
{
Q_D(const QCamera);
if (d->control == nullptr)
return QMultimedia::ServiceMissing;
if (d->deviceControl && d->deviceControl->deviceCount() == 0)
return QMultimedia::ResourceError;
if (d->error != QCamera::NoError)
return QMultimedia::ResourceError;
return QMediaObject::availability();
}
/*!
Returns the camera exposure control object.
*/
QCameraExposure *QCamera::exposure() const
{
return d_func()->cameraExposure;
}
/*!
Returns the camera focus control object.
*/
QCameraFocus *QCamera::focus() const
{
return d_func()->cameraFocus;
}
/*!
Returns the camera image processing control object.
*/
QCameraImageProcessing *QCamera::imageProcessing() const
{
return d_func()->imageProcessing;
}
/*!
Sets the QVideoWidget based camera \a viewfinder.
The previously set viewfinder is detached.
//! QVideoWidget is forward declared.
*/
void QCamera::setViewfinder(QVideoWidget *viewfinder)
{
Q_D(QCamera);
d->_q_preparePropertyChange(QCameraControl::Viewfinder);
if (d->viewfinder)
unbind(d->viewfinder);
// We don't know (in this library) that QVideoWidget inherits QObject
QObject *viewFinderObject = reinterpret_cast<QObject*>(viewfinder);
d->viewfinder = viewFinderObject && bind(viewFinderObject) ? viewFinderObject : nullptr;
}
/*!
Sets the QGraphicsVideoItem based camera \a viewfinder.
The previously set viewfinder is detached.
//! QGraphicsVideoItem is forward declared.
*/
void QCamera::setViewfinder(QGraphicsVideoItem *viewfinder)
{
Q_D(QCamera);
d->_q_preparePropertyChange(QCameraControl::Viewfinder);
if (d->viewfinder)
unbind(d->viewfinder);
// We don't know (in this library) that QGraphicsVideoItem (multiply) inherits QObject
// but QObject inheritance depends on QObject coming first, so try this out.
QObject *viewFinderObject = reinterpret_cast<QObject*>(viewfinder);
d->viewfinder = viewFinderObject && bind(viewFinderObject) ? viewFinderObject : nullptr;
}
/*!
Sets a video \a surface as the viewfinder of a camera.
If a viewfinder has already been set on the camera the new surface
will replace it.
*/
void QCamera::setViewfinder(QAbstractVideoSurface *surface)
{
Q_D(QCamera);
d->surfaceViewfinder.setVideoSurface(surface);
if (d->viewfinder != &d->surfaceViewfinder) {
if (d->viewfinder)
unbind(d->viewfinder);
d->viewfinder = nullptr;
if (surface && bind(&d->surfaceViewfinder))
d->viewfinder = &d->surfaceViewfinder;
} else if (!surface) {
//unbind the surfaceViewfinder if null surface is set
unbind(&d->surfaceViewfinder);
d->viewfinder = nullptr;
}
}
/*!
Returns the viewfinder settings being used by the camera.
Settings may change when the camera is started, for example if the viewfinder settings
are undefined or if unsupported values are set.
If viewfinder settings are not supported by the camera, it always returns a null
QCameraViewfinderSettings object.
\sa setViewfinderSettings()
\since 5.5
*/
QCameraViewfinderSettings QCamera::viewfinderSettings() const
{
Q_D(const QCamera);
if (d->viewfinderSettingsControl2)
return d->viewfinderSettingsControl2->viewfinderSettings();
QCameraViewfinderSettings settings;
if (d->viewfinderSettingsControl) {
if (d->viewfinderSettingsControl->isViewfinderParameterSupported(QCameraViewfinderSettingsControl::Resolution))
settings.setResolution(d->viewfinderSettingsControl->viewfinderParameter(QCameraViewfinderSettingsControl::Resolution).toSize());
if (d->viewfinderSettingsControl->isViewfinderParameterSupported(QCameraViewfinderSettingsControl::MinimumFrameRate))
settings.setMinimumFrameRate(d->viewfinderSettingsControl->viewfinderParameter(QCameraViewfinderSettingsControl::MinimumFrameRate).toReal());
if (d->viewfinderSettingsControl->isViewfinderParameterSupported(QCameraViewfinderSettingsControl::MaximumFrameRate))
settings.setMaximumFrameRate(d->viewfinderSettingsControl->viewfinderParameter(QCameraViewfinderSettingsControl::MaximumFrameRate).toReal());
if (d->viewfinderSettingsControl->isViewfinderParameterSupported(QCameraViewfinderSettingsControl::PixelAspectRatio))
settings.setPixelAspectRatio(d->viewfinderSettingsControl->viewfinderParameter(QCameraViewfinderSettingsControl::PixelAspectRatio).toSize());
if (d->viewfinderSettingsControl->isViewfinderParameterSupported(QCameraViewfinderSettingsControl::PixelFormat))
settings.setPixelFormat(qvariant_cast<QVideoFrame::PixelFormat>(d->viewfinderSettingsControl->viewfinderParameter(QCameraViewfinderSettingsControl::PixelFormat)));
}
return settings;
}
/*!
Sets the viewfinder \a settings.
If some parameters are not specified, or null settings are passed, the camera will choose
default values.
If the camera is used to capture videos or images, the viewfinder settings might be
ignored if they conflict with the capture settings. You can check the actual viewfinder settings
once the camera is in the \c QCamera::ActiveStatus status.
Changing the viewfinder settings while the camera is in the QCamera::ActiveState state may
cause the camera to be restarted.
\sa viewfinderSettings(), supportedViewfinderResolutions(), supportedViewfinderFrameRateRanges(),
supportedViewfinderPixelFormats()
\since 5.5
*/
void QCamera::setViewfinderSettings(const QCameraViewfinderSettings &settings)
{
Q_D(QCamera);
if (d->viewfinderSettingsControl || d->viewfinderSettingsControl2)
d->_q_preparePropertyChange(QCameraControl::ViewfinderSettings);
if (d->viewfinderSettingsControl2) {
d->viewfinderSettingsControl2->setViewfinderSettings(settings);
} else if (d->viewfinderSettingsControl) {
if (d->viewfinderSettingsControl->isViewfinderParameterSupported(QCameraViewfinderSettingsControl::Resolution))
d->viewfinderSettingsControl->setViewfinderParameter(QCameraViewfinderSettingsControl::Resolution, settings.resolution());
if (d->viewfinderSettingsControl->isViewfinderParameterSupported(QCameraViewfinderSettingsControl::MinimumFrameRate))
d->viewfinderSettingsControl->setViewfinderParameter(QCameraViewfinderSettingsControl::MinimumFrameRate, settings.minimumFrameRate());
if (d->viewfinderSettingsControl->isViewfinderParameterSupported(QCameraViewfinderSettingsControl::MaximumFrameRate))
d->viewfinderSettingsControl->setViewfinderParameter(QCameraViewfinderSettingsControl::MaximumFrameRate, settings.maximumFrameRate());
if (d->viewfinderSettingsControl->isViewfinderParameterSupported(QCameraViewfinderSettingsControl::PixelAspectRatio))
d->viewfinderSettingsControl->setViewfinderParameter(QCameraViewfinderSettingsControl::PixelAspectRatio, settings.pixelAspectRatio());
if (d->viewfinderSettingsControl->isViewfinderParameterSupported(QCameraViewfinderSettingsControl::PixelFormat))
d->viewfinderSettingsControl->setViewfinderParameter(QCameraViewfinderSettingsControl::PixelFormat, settings.pixelFormat());
}
}
/*!
Returns a list of supported viewfinder settings.
The list is ordered by preference; preferred settings come first.
The optional \a settings argument can be used to conveniently filter the results.
If \a settings is non null, the returned list is reduced to settings matching the given partial
\a settings.
The status of the camera must be LoadedStatus before calling this function, otherwise the returned list
is empty.
\sa setViewfinderSettings(), supportedViewfinderResolutions(), supportedViewfinderFrameRateRanges(),
supportedViewfinderPixelFormats()
\since 5.5
*/
QList<QCameraViewfinderSettings> QCamera::supportedViewfinderSettings(const QCameraViewfinderSettings &settings) const
{
Q_D(const QCamera);
if (!d->viewfinderSettingsControl2)
return QList<QCameraViewfinderSettings>();
if (settings.isNull())
return d->viewfinderSettingsControl2->supportedViewfinderSettings();
QList<QCameraViewfinderSettings> results;
const QList<QCameraViewfinderSettings> supported = d->viewfinderSettingsControl2->supportedViewfinderSettings();
for (const QCameraViewfinderSettings &s : supported) {
if ((settings.resolution().isEmpty() || settings.resolution() == s.resolution())
&& (qFuzzyIsNull(settings.minimumFrameRate()) || qFuzzyCompare((float)settings.minimumFrameRate(), (float)s.minimumFrameRate()))
&& (qFuzzyIsNull(settings.maximumFrameRate()) || qFuzzyCompare((float)settings.maximumFrameRate(), (float)s.maximumFrameRate()))
&& (settings.pixelFormat() == QVideoFrame::Format_Invalid || settings.pixelFormat() == s.pixelFormat())
&& (settings.pixelAspectRatio().isEmpty() || settings.pixelAspectRatio() == s.pixelAspectRatio())) {
results.append(s);
}
}
return results;
}
/*!
Returns a list of supported viewfinder resolutions.
This is a convenience function which retrieves unique resolutions from the supported settings.
If non null viewfinder \a settings are passed, the returned list is reduced to resolutions
supported with partial \a settings applied.
The camera must be loaded before calling this function, otherwise the returned list
is empty.
\sa QCameraViewfinderSettings::resolution(), setViewfinderSettings()
\since 5.5
*/
QList<QSize> QCamera::supportedViewfinderResolutions(const QCameraViewfinderSettings &settings) const
{
QList<QSize> resolutions;
const QList<QCameraViewfinderSettings> capabilities = supportedViewfinderSettings(settings);
for (const QCameraViewfinderSettings &s : capabilities) {
if (!resolutions.contains(s.resolution()))
resolutions.append(s.resolution());
}
std::sort(resolutions.begin(), resolutions.end(), qt_sizeLessThan);
return resolutions;
}
/*!
Returns a list of supported viewfinder frame rate ranges.
This is a convenience function which retrieves unique frame rate ranges from the supported settings.
If non null viewfinder \a settings are passed, the returned list is reduced to frame rate ranges
supported with partial \a settings applied.
The camera must be loaded before calling this function, otherwise the returned list
is empty.
\sa QCameraViewfinderSettings::minimumFrameRate(), QCameraViewfinderSettings::maximumFrameRate(),
setViewfinderSettings()
\since 5.5
*/
QList<QCamera::FrameRateRange> QCamera::supportedViewfinderFrameRateRanges(const QCameraViewfinderSettings &settings) const
{
QList<QCamera::FrameRateRange> frameRateRanges;
const QList<QCameraViewfinderSettings> capabilities = supportedViewfinderSettings(settings);
for (const QCameraViewfinderSettings &s : capabilities) {
QCamera::FrameRateRange range(s.minimumFrameRate(), s.maximumFrameRate());
if (!frameRateRanges.contains(range))
frameRateRanges.append(range);
}
std::sort(frameRateRanges.begin(), frameRateRanges.end(), qt_frameRateRangeLessThan);
return frameRateRanges;
}
/*!
Returns a list of supported viewfinder pixel formats.
This is a convenience function which retrieves unique pixel formats from the supported settings.
If non null viewfinder \a settings are passed, the returned list is reduced to pixel formats
supported with partial \a settings applied.
The camera must be loaded before calling this function, otherwise the returned list
is empty.
\sa QCameraViewfinderSettings::pixelFormat(), setViewfinderSettings()
\since 5.5
*/
QList<QVideoFrame::PixelFormat> QCamera::supportedViewfinderPixelFormats(const QCameraViewfinderSettings &settings) const
{
QList<QVideoFrame::PixelFormat> pixelFormats;
const QList<QCameraViewfinderSettings> capabilities = supportedViewfinderSettings(settings);
for (const QCameraViewfinderSettings &s : capabilities) {
if (!pixelFormats.contains(s.pixelFormat()))
pixelFormats.append(s.pixelFormat());
}
return pixelFormats;
}
/*!
Returns the error state of the object.
*/
QCamera::Error QCamera::error() const
{
return d_func()->error;
}
/*!
Returns a string describing a camera's error state.
*/
QString QCamera::errorString() const
{
return d_func()->errorString;
}
/*!
Returns true if the capture \a mode is suported.
*/
bool QCamera::isCaptureModeSupported(QCamera::CaptureModes mode) const
{
return d_func()->control ? d_func()->control->isCaptureModeSupported(mode) : false;
}
/*!
\property QCamera::captureMode
The type of media (video or still images),
the camera is configured to capture.
It's allowed to change capture mode in any camera state,
but if the camera is currently active,
chaging capture mode is likely to lead to camera status
chaged to QCamera::LoadedStatus, QCamera::LoadingStatus,
and when the camera is ready to QCamera::ActiveStatus.
*/
QCamera::CaptureModes QCamera::captureMode() const
{
return d_func()->control ? d_func()->control->captureMode() : QCamera::CaptureStillImage;
}
void QCamera::setCaptureMode(QCamera::CaptureModes mode)
{
Q_D(QCamera);
if (mode != captureMode()) {
if (d->control) {
d->_q_preparePropertyChange(QCameraControl::CaptureMode);
d->control->setCaptureMode(mode);
}
}
}
/*!
Starts the camera.
State is changed to QCamera::ActiveState if camera is started
successfully, otherwise errorOccurred() signal is emitted.
While the camera state is changed to QCamera::ActiveState,
starting the camera service can be asynchronous with the actual
status reported with QCamera::status property.
*/
void QCamera::start()
{
Q_D(QCamera);
d->setState(QCamera::ActiveState);
}
/*!
Stops the camera.
The camera state is changed from QCamera::ActiveState to QCamera::LoadedState.
In this state, the camera still consumes power.
\sa unload(), QCamera::UnloadedState
*/
void QCamera::stop()
{
Q_D(QCamera);
d->setState(QCamera::LoadedState);
}
/*!
Opens the camera device.
The camera state is changed to QCamera::LoadedState.
It's not necessary to explicitly load the camera, unless the application
needs to read the supported camera settings and change the default values
according to the camera capabilities.
In all the other cases, it's possible to start the camera directly
from the unloaded state.
/sa QCamera::UnloadedState
*/
void QCamera::load()
{
Q_D(QCamera);
d->setState(QCamera::LoadedState);
}
/*!
Closes the camera device and deallocates the related resources.
The camera state is changed to QCamera::UnloadedState.
*/
void QCamera::unload()
{
Q_D(QCamera);
d->setState(QCamera::UnloadedState);
}
#if QT_DEPRECATED_SINCE(5, 3)
/*!
Returns a list of camera device's available from the default service provider.
\deprecated
\sa QCameraInfo::availableCameras()
*/
QList<QByteArray> QCamera::availableDevices()
{
return QMediaServiceProvider::defaultServiceProvider()->devices(QByteArray(Q_MEDIASERVICE_CAMERA));
}
/*!
Returns the description of the \a device.
\deprecated
\sa QCameraInfo::availableCameras(), QCameraInfo::description()
*/
QString QCamera::deviceDescription(const QByteArray &device)
{
return QMediaServiceProvider::defaultServiceProvider()->deviceDescription(QByteArray(Q_MEDIASERVICE_CAMERA), device);
}
#endif
QCamera::State QCamera::state() const
{
return d_func()->state;
}
QCamera::Status QCamera::status() const
{
if(d_func()->control)
return (QCamera::Status)d_func()->control->status();
return QCamera::UnavailableStatus;
}
/*!
Returns the lock types that the camera supports.
*/
QCamera::LockTypes QCamera::supportedLocks() const
{
Q_D(const QCamera);
return d->locksControl
? d->locksControl->supportedLocks()
: QCamera::LockTypes();
}
/*!
Returns the requested lock types.
*/
QCamera::LockTypes QCamera::requestedLocks() const
{
return d_func()->requestedLocks;
}
/*!
Returns the status of requested camera settings locks.
*/
QCamera::LockStatus QCamera::lockStatus() const
{
return d_func()->lockStatus;
}
/*!
Returns the lock status for a given \a lockType.
*/
QCamera::LockStatus QCamera::lockStatus(QCamera::LockType lockType) const
{
const QCameraPrivate *d = d_func();
if (!(lockType & d->requestedLocks))
return QCamera::Unlocked;
if (d->locksControl)
return d->locksControl->lockStatus(lockType);
return QCamera::Locked;
}
/*!
\fn void QCamera::searchAndLock(QCamera::LockTypes locks)
Locks the camera settings with the requested \a locks, including focusing in the single autofocus mode,
exposure and white balance if the exposure and white balance modes are not manual.
The camera settings are usually locked before taking one or multiple still images,
in responce to the shutter button being half pressed.
The QCamera::locked() signal is emitted when camera settings are successfully locked,
otherwise QCamera::lockFailed() is emitted.
QCamera also emits lockStatusChanged(QCamera::LockType, QCamera::LockStatus)
on individual lock status changes and lockStatusChanged(QCamera::LockStatus) signal on composite status changes.
Locking serves two roles: it initializes calculation of automatic parameter
(focusing, calculating the correct exposure and white balance) and allows
to keep some or all of those parameters during number of shots.
If the camera doesn't support keeping one of parameters between shots, the related
lock state changes to QCamera::Unlocked.
It's also acceptable to relock already locked settings,
depending on the lock parameter this initiates new focusing, exposure or white balance calculation.
*/
void QCamera::searchAndLock(QCamera::LockTypes locks)
{
Q_D(QCamera);
QCamera::LockStatus oldStatus = d->lockStatus;
d->supressLockChangedSignal = true;
if (d->locksControl) {
locks &= d->locksControl->supportedLocks();
d->requestedLocks |= locks;
d->locksControl->searchAndLock(locks);
}
d->supressLockChangedSignal = false;
d->lockStatus = oldStatus;
d->updateLockStatus();
}
/*!
Lock all the supported camera settings.
*/
void QCamera::searchAndLock()
{
searchAndLock(LockExposure | LockWhiteBalance | LockFocus);
}
/*!
Unlocks the camera settings specified with \a locks or cancel the current locking if one is active.
*/
void QCamera::unlock(QCamera::LockTypes locks)
{
Q_D(QCamera);
QCamera::LockStatus oldStatus = d->lockStatus;
d->supressLockChangedSignal = true;
d->requestedLocks &= ~locks;
if (d->locksControl) {
locks &= d->locksControl->supportedLocks();
d->locksControl->unlock(locks);
}
d->supressLockChangedSignal = false;
d->lockStatus = oldStatus;
d->updateLockStatus();
}
/*!
Unlock all the requested camera locks.
*/
void QCamera::unlock()
{
unlock(d_func()->requestedLocks);
}
/*!
\class QCamera::FrameRateRange
\inmodule QtMultimedia
\ingroup multimedia
\ingroup multimedia_camera
\since 5.5
\brief A FrameRateRange represents a range of frame rates as minimum and maximum rate.
If the minimum frame rate is equal to the maximum frame rate, the frame rate is fixed.
If not, the actual frame rate fluctuates between the minimum and the maximum.
\sa QCamera::supportedViewfinderFrameRateRanges(), QCameraViewfinderSettings
*/
/*!
\fn QCamera::FrameRateRange::FrameRateRange()
Constructs a null frame rate range, with both minimumFrameRate and maximumFrameRate
equal to \c 0.0.
*/
/*!
\fn QCamera::FrameRateRange::FrameRateRange(qreal minimum, qreal maximum)
Constructs a frame rate range with the given \a minimum and \a maximum frame rates.
*/
/*!
\variable QCamera::FrameRateRange::minimumFrameRate
The minimum frame rate supported by the range, in frames per second.
*/
/*!
\variable QCamera::FrameRateRange::maximumFrameRate
The maximum frame rate supported by the range, in frames per second.
*/
/*!
\enum QCamera::State
This enum holds the current state of the camera.
\value UnloadedState
The initial camera state, with camera not loaded.
The camera capabilities, except supported capture modes,
are unknown.
While the supported settings are unknown in this state,
it's allowed to set the camera capture settings like codec,
resolution, or frame rate.
\value LoadedState
The camera is loaded and ready to be configured.
In this state it's allowed to query camera capabilities,
set capture resolution, codecs, etc.
The viewfinder is not active in the loaded state.
The camera consumes power in the loaded state.
\value ActiveState
In the active state as soon as camera is started
the viewfinder displays video frames and the
camera is ready for capture.
*/
/*!
\property QCamera::state
\brief The current state of the camera object.
*/
/*!
\enum QCamera::Status
This enum holds the current status of the camera.
\value ActiveStatus
The camera has been started and can produce data.
The viewfinder displays video frames in active state.
Depending on backend, changing some camera settings like
capture mode, codecs or resolution in ActiveState may lead
to changing the camera status to LoadedStatus and StartingStatus while
the settings are applied and back to ActiveStatus when the camera is ready.
\value StartingStatus
The camera is starting in result of state transition to QCamera::ActiveState.
The camera service is not ready to capture yet.
\value StoppingStatus
The camera is stopping in result of state transition from QCamera::ActiveState
to QCamera::LoadedState or QCamera::UnloadedState.
\value StandbyStatus
The camera is in the power saving standby mode.
The camera may come to the standby mode after some time of inactivity
in the QCamera::LoadedState state.
\value LoadedStatus
The camera is loaded and ready to be configured.
This status indicates the camera device is opened and
it's possible to query for supported image and video capture settings,
like resolution, framerate and codecs.
\value LoadingStatus
The camera device loading in result of state transition from
QCamera::UnloadedState to QCamera::LoadedState or QCamera::ActiveState.
\value UnloadingStatus
The camera device is unloading in result of state transition from
QCamera::LoadedState or QCamera::ActiveState to QCamera::UnloadedState.
\value UnloadedStatus
The initial camera status, with camera not loaded.
The camera capabilities including supported capture settings may be unknown.
\value UnavailableStatus
The camera or camera backend is not available.
*/
/*!
\property QCamera::status
\brief The current status of the camera object.
*/
/*!
\enum QCamera::CaptureMode
This enum holds the capture mode of the camera.
\value CaptureViewfinder Camera is only configured to display viewfinder.
\value CaptureStillImage Camera is configured for still frames capture.
\value CaptureVideo Camera is configured for video capture.
*/
/*!
\enum QCamera::LockType
This enum holds the camera lock type.
\value NoLock
\value LockExposure
Lock camera exposure.
\value LockWhiteBalance
Lock the white balance.
\value LockFocus
Lock camera focus.
*/
/*!
\property QCamera::lockStatus
\brief The overall status for all the requested camera locks.
*/
/*!
\fn void QCamera::locked()
Signals all the requested camera settings are locked.
*/
/*!
\fn void QCamera::lockFailed()
Signals locking of at least one requested camera settings failed.
*/
/*!
\fn QCamera::lockStatusChanged(QCamera::LockStatus status, QCamera::LockChangeReason reason)
Signals the overall \a status for all the requested camera locks was changed with specified \a reason.
*/
/*!
\fn QCamera::lockStatusChanged(QCamera::LockType lock, QCamera::LockStatus status, QCamera::LockChangeReason reason)
Signals the \a lock \a status was changed with specified \a reason.
*/
/*!
\enum QCamera::LockStatus
This enum holds the overall status for all the requested camera locks.
\value Unlocked
The application is not interested in camera settings value.
The camera may keep this parameter without changes, this is common with camera focus,
or adjust exposure and white balance constantly to keep the viewfinder image nice.
\value Searching
The application has requested the camera focus, exposure or white balance lock with
QCamera::searchAndLock(). This state indicates the camera is focusing or
calculating exposure and white balance.
\value Locked
The camera focus, exposure or white balance is locked.
The camera is ready to capture, application may check the exposure
stays the same, parameters. The \c Locked status usually means the
requested parameter except in the cases when the parameter is requested
to be constantly updated. For example, in continuous focusing mode,
the focus is considered locked as long as the object is in focus, even
while the actual focusing distance may be constantly changing.
*/
/*!
\enum QCamera::LockChangeReason
This enum holds the reason why the camera lock status changed.
\value UserRequest
The lock status changed in result of user request, usually to unlock camera settings.
\value LockAcquired
The lock status successfuly changed to QCamera::Locked.
\value LockFailed
The camera failed to acquire the requested lock in result of
autofocus failure, exposure out of supported range, etc.
\value LockLost
The camera is not able to maintain the requested lock any more.
Lock status is changed to QCamera::Unlocked.
\value LockTemporaryLost
The lock is lost, but the camera is working hard to reacquire it.
This value may be used in continuous focusing mode,
when the camera loses the focus, the focus lock state is changed to Qcamera::Searching
with LockTemporaryLost reason.
*/
/*!
\enum QCamera::Error
This enum holds the last error code.
\value NoError No errors have occurred.
\value CameraError An error has occurred.
\value InvalidRequestError System resource doesn't support requested functionality.
\value ServiceMissingError No camera service available.
\value NotSupportedFeatureError The feature is not supported.
*/
/*!
\fn void QCamera::error(QCamera::Error value)
\obsolete
Use errorOccurred() instead.
*/
/*!
\fn void QCamera::errorOccurred(QCamera::Error value)
\since 5.15
Signal emitted when error state changes to \a value.
*/
/*!
\enum QCamera::Position
\since 5.3
This enum specifies the physical position of the camera on the system hardware.
\value UnspecifiedPosition The camera position is unspecified or unknown.
\value BackFace The camera is on the back face of the system hardware. For example on a
mobile device, it means it is on the opposite side to that of the screen.
\value FrontFace The camera is on the front face of the system hardware. For example on a
mobile device, it means it is on the same side as that of the screen. Viewfinder frames of
front-facing cameras are mirrored horizontally, so the users can see themselves as looking
into a mirror. Captured images or videos are not mirrored.
\sa QCameraInfo::position()
*/
/*!
\fn void QCamera::captureModeChanged(QCamera::CaptureModes mode)
Signals the capture \a mode has changed.
*/
/*!
\fn QCamera::stateChanged(QCamera::State state)
Signals the camera \a state has changed.
Usually the state changes is caused by calling
load(), unload(), start() and stop(),
but the state can also be changed change as a result of camera error.
*/
/*!
\fn QCamera::statusChanged(QCamera::Status status)
Signals the camera \a status has changed.
*/
QT_END_NAMESPACE
#include "moc_qcamera.cpp"