// Copyright (C) 2016 The Qt Company Ltd. // SPDX-License-Identifier: LicenseRef-Qt-Commercial OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only #include "qcameradevice_p.h" #include "qcamera_p.h" QT_BEGIN_NAMESPACE /*! \class QCameraFormat \since 6.2 \brief The QCameraFormat class describes a video format supported by a camera device. \inmodule QtMultimedia \ingroup multimedia \ingroup multimedia_camera QCameraFormat represents a certain video format supported by a camera device. The format is a combination of a \l{QVideoFrameFormat::PixelFormat}{pixel format}, resolution and a range of frame rates. QCameraFormat objects can be queried from QCameraDevice to inspect the set of supported video formats. \sa QCameraDevice, QCamera */ /*! \qmlvaluetype cameraFormat \ingroup qmlvaluetypes \inqmlmodule QtMultimedia \since 6.2 //! \instantiates QCameraFormat \brief Describes a video format supported by a camera device. \ingroup multimedia_qml \ingroup multimedia_video_qml cameraFormat represents a certain video format supported by a camera device. The format is a combination of a \l{pixel format}{QVideoFrameFormat::PixelFormat}, resolution and a range of frame rates. cameraFormat objects can be queried from \l cameraDevice to inspect the set of supported video formats. \sa cameraDevice, Camera */ /*! Constructs a null camera format. \sa isNull() */ QCameraFormat::QCameraFormat() noexcept = default; /*! Copy constructs a camera format from the \a other format. */ QCameraFormat::QCameraFormat(const QCameraFormat &other) noexcept = default; /*! Assign \a other to this. */ QCameraFormat &QCameraFormat::operator=(const QCameraFormat &other) noexcept = default; /*! Destructs the camera format object. */ QCameraFormat::~QCameraFormat() = default; /*! \fn bool QCameraFormat::isNull() const noexcept Returns true if this is a default constructed QCameraFormat. */ /*! \qmlproperty enumeration QtMultimedia::cameraFormat::pixelFormat Holds the pixel format. Most commonly this is either QVideoFrameFormat::Format_Jpeg or QVideoFrameFormat::Format_YUVY but other formats could also be supported by the camera. \sa QVideoFrameFormat::PixelFormat */ /*! \property QCameraFormat::pixelFormat Returns the pixel format. Most commonly this is either QVideoFrameFormat::Format_Jpeg or QVideoFrameFormat::Format_YUVY but other formats could also be supported by the camera. \sa QVideoFrameFormat::PixelFormat */ QVideoFrameFormat::PixelFormat QCameraFormat::pixelFormat() const noexcept { return d ? d->pixelFormat : QVideoFrameFormat::Format_Invalid; } /*! \qmlproperty size QtMultimedia::cameraFormat::resolution Returns the resolution. */ /*! \property QCameraFormat::resolution Returns the resolution. */ QSize QCameraFormat::resolution() const noexcept { return d ? d->resolution : QSize(); } /*! \qmlproperty real QtMultimedia::cameraFormat::minFrameRate Returns the lowest frame rate defined by this format. */ /*! \property QCameraFormat::minFrameRate Returns the lowest frame rate defined by this format. */ float QCameraFormat::minFrameRate() const noexcept { return d ? d->minFrameRate : 0; } /*! \qmlproperty real QtMultimedia::cameraFormat::maxFrameRate Returns the highest frame rate defined by this format. The camera will always try to use the maximum frame rate supported by a certain video format. */ /*! \property QCameraFormat::maxFrameRate Returns the highest frame rate defined by this format. The camera will always try to use the highest frame rate supported by a certain video format. */ float QCameraFormat::maxFrameRate() const noexcept { return d ? d->maxFrameRate : 0; } /*! \internal */ QCameraFormat::QCameraFormat(QCameraFormatPrivate *p) : d(p) { } /*! Returns \c true if the \a other format is equal to this camera format, otherwise \c false. */ bool QCameraFormat::operator==(const QCameraFormat &other) const { if (d == other.d) return true; if (!d || !other.d) return false; return d->pixelFormat == other.d->pixelFormat && d->minFrameRate == other.d->minFrameRate && d->maxFrameRate == other.d->maxFrameRate && d->resolution == other.d->resolution; } /*! \fn bool QCameraFormat::operator!=(const QCameraFormat &other) const Returns \c false if the \a other format is equal to this camera format, otherwise \c true. */ /*! \class QCameraDevice \brief The QCameraDevice class provides general information about camera devices. \inmodule QtMultimedia \ingroup multimedia \ingroup multimedia_camera QCameraDevice represents a physical camera device and its properties. You can discover what cameras are available on a system using the availableCameras() and defaultCamera() functions. These are contained within QtMultimedia::MediaDevices. This example prints the name of all available cameras: \snippet multimedia-snippets/camera.cpp Camera listing A QCameraDevice can be used to construct a QCamera. The following example instantiates a QCamera whose camera device is named \c {mycamera}: \snippet multimedia-snippets/camera.cpp Camera selection You can also use QCameraDevice to get general information about a camera device such as description and physical position on the system. \snippet multimedia-snippets/camera.cpp Camera info \sa QCamera */ /*! \qmlvaluetype cameraDevice \ingroup qmlvaluetypes \inqmlmodule QtMultimedia \since 6.2 //! \instantiates QCameraDevice \brief Describes a camera device. \ingroup multimedia_qml \ingroup multimedia_video_qml The cameraDevice value type describes the properties of a camera device that is connected to the system. The list of camera devices can be queried from the \l{MediaDevices} type. To select a certain camera device set it as the device on \l{Camera}. \qml CaptureSession { camera: Camera { cameraDevice: mediaDevices.defaultVideoInput } } MediaDevices { id: mediaDevices } \endqml */ /*! Constructs a null camera device */ QCameraDevice::QCameraDevice() = default; /*! Constructs a copy of \a other. */ QCameraDevice::QCameraDevice(const QCameraDevice &other) = default; /*! Destroys the QCameraDevice. */ QCameraDevice::~QCameraDevice() = default; /*! Returns true if this QCameraDevice is equal to \a other. */ bool QCameraDevice::operator==(const QCameraDevice &other) const { if (d == other.d) return true; if (!d || ! other.d) return false; return (d->id == other.d->id && d->description == other.d->description && d->position == other.d->position); } /*! Returns true if this QCameraDevice is null or invalid. */ bool QCameraDevice::isNull() const { return !d; } /*! \qmlproperty string QtMultimedia::cameraDevice::id Holds he device id of the camera This is a unique ID to identify the camera and may not be human-readable. */ /*! \property QCameraDevice::id Returns the device id of the camera This is a unique ID to identify the camera and may not be human-readable. */ QByteArray QCameraDevice::id() const { return d ? d->id : QByteArray(); } /*! \qmlproperty bool QtMultimedia::cameraDevice::isDefault Is true if this is the default camera device. */ /*! \property QCameraDevice::isDefault Returns true if this is the default camera device. */ bool QCameraDevice::isDefault() const { return d ? d->isDefault : false; } /*! \since 6.7 \qmlproperty QtVideo::Rotation QtMultimedia::cameraDevice::correctionAngle Returns the rotation angle needed to compensate for the physical camera rotation of the camera compared to its native orientation. In other words, the property represents the clockwise angle through which the output image needs to be rotated to be upright on the device screen in its native orientation. Since \a correctionAngle is relative to the native orientation, this value does not change with altering the device orientation (portrait/landscape). The correction angle may be non-zero mostly on Android, where native and camera orientations are defined by the manufacturer. \image camera_correctionAngle_90.png Example with 90 degrees \a correctionAngle */ /*! \since 6.7 \property QCameraDevice::correctionAngle Returns the rotation angle needed to compensate for the physical camera rotation of the camera compared to its native orientation. In other words, the property represents the clockwise angle through which the output image needs to be rotated to be upright on the device screen in its native orientation. Since \a correctionAngle is relative to the native orientation, this value does not change with altering the device orientation (portrait/landscape). The correction angle may be non-zero mostly on Android, where native and camera orientations are defined by the manufacturer. \image camera_correctionAngle_90.png Example with 90 degrees \a correctionAngle */ QtVideo::Rotation QCameraDevice::correctionAngle() const { return d ? QtVideo::Rotation(d->orientation) : QtVideo::Rotation::None; } /*! \qmlproperty string QtMultimedia::cameraDevice::description Holds a human readable name of the camera. Use this string to present the device to the user. */ /*! \property QCameraDevice::description Returns the human-readable description of the camera. Use this string to present the device to the user. */ QString QCameraDevice::description() const { return d ? d->description : QString(); } /*! \enum QCameraDevice::Position 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. \sa position() */ /*! \qmlproperty enumeration QtMultimedia::cameraDevice::position Returns the physical position of the camera on the hardware system. The returned value can be one of the following: \value cameraDevice.UnspecifiedPosition The camera position is unspecified or unknown. \value cameraDevice.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 cameraDevice.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. */ /*! \property QCameraDevice::position Returns the physical position of the camera on the hardware system. */ QCameraDevice::Position QCameraDevice::position() const { return d ? d->position : QCameraDevice::UnspecifiedPosition; } /*! Returns a list of resolutions that the camera can use to capture still images. \sa QImageCapture */ QList QCameraDevice::photoResolutions() const { return d ? d->photoResolutions : QList{}; } /*! \qmlproperty CameraFormat QtMultimedia::cameraDevice::videoFormats Holds the video formats supported by the camera. */ /*! \property QCameraDevice::videoFormats Returns the video formats supported by the camera. */ QList QCameraDevice::videoFormats() const { return d ? d->videoFormats : QList{}; } QCameraDevice::QCameraDevice(QCameraDevicePrivate *p) : d(p) {} /*! Sets the QCameraDevice object to be equal to \a other. */ QCameraDevice& QCameraDevice::operator=(const QCameraDevice& other) = default; /*! \fn QCameraDevice::operator!=(const QCameraDevice &other) const Returns true if this QCameraDevice is different from \a other. */ #ifndef QT_NO_DEBUG_STREAM QDebug operator<<(QDebug d, const QCameraDevice &camera) { d.maybeSpace() << QStringLiteral("QCameraDevice(name=%1, id=%2, position=%3)") .arg(camera.description()) .arg(QLatin1StringView(camera.id())) .arg(QLatin1StringView( QMetaEnum::fromType().valueToKey( camera.position()))); return d.space(); } #endif QT_END_NAMESPACE #include "moc_qcameradevice.cpp"