qvideoframeformat.cpp

Go to the documentation of this file.

// 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 "qvideoframeformat.h"
#include "qvideotexturehelper_p.h"
 
#include <qdebug.h>
#include <qlist.h>
#include <qmetatype.h>
#include <qpair.h>
#include <qvariant.h>
#include <qmatrix4x4.h>
 
static void initResource() {
    Q_INIT_RESOURCE(qtmultimedia_shaders);
}
 
QT_BEGIN_NAMESPACE
 
class QVideoFrameFormatPrivate : public QSharedData
{
public:
    QVideoFrameFormatPrivate() = default;
 
    QVideoFrameFormatPrivate(
            const QSize &size,
            QVideoFrameFormat::PixelFormat format)
        : pixelFormat(format)
        , frameSize(size)
        , viewport(QPoint(0, 0), size)
    {
    }
 
    bool operator ==(const QVideoFrameFormatPrivate &other) const
    {
        if (pixelFormat == other.pixelFormat
            && scanLineDirection == other.scanLineDirection
            && frameSize == other.frameSize
            && viewport == other.viewport
            && frameRatesEqual(frameRate, other.frameRate)
            && colorSpace == other.colorSpace
            && mirrored == other.mirrored
            && rotation == other.rotation)
            return true;
 
        return false;
    }
 
    inline static bool frameRatesEqual(qreal r1, qreal r2)
    {
        return qAbs(r1 - r2) <= 0.00001 * qMin(qAbs(r1), qAbs(r2));
    }
 
    QVideoFrameFormat::PixelFormat pixelFormat = QVideoFrameFormat::Format_Invalid;
    QVideoFrameFormat::Direction scanLineDirection = QVideoFrameFormat::TopToBottom;
    QSize frameSize;
    QVideoFrameFormat::ColorSpace colorSpace = QVideoFrameFormat::ColorSpace_Undefined;
    QVideoFrameFormat::ColorTransfer colorTransfer = QVideoFrameFormat::ColorTransfer_Unknown;
    QVideoFrameFormat::ColorRange colorRange = QVideoFrameFormat::ColorRange_Unknown;
    QRect viewport;
    float frameRate = 0.0;
    float maxLuminance = -1.;
    bool mirrored = false;
    QtVideo::Rotation rotation = QtVideo::Rotation::None;
};
 
QT_DEFINE_QESDP_SPECIALIZATION_DTOR(QVideoFrameFormatPrivate);
 
QVideoFrameFormat::QVideoFrameFormat()
    : d(new QVideoFrameFormatPrivate)
{
    initResource();
}
 
QVideoFrameFormat::QVideoFrameFormat(
        const QSize& size, QVideoFrameFormat::PixelFormat format)
    : d(new QVideoFrameFormatPrivate(size, format))
{
}
 
QVideoFrameFormat::QVideoFrameFormat(const QVideoFrameFormat &other) = default;
 
QVideoFrameFormat &QVideoFrameFormat::operator =(const QVideoFrameFormat &other) = default;
 
QVideoFrameFormat::~QVideoFrameFormat() = default;
 
bool QVideoFrameFormat::isValid() const
{
    return d->pixelFormat != Format_Invalid && d->frameSize.isValid();
}
 
bool QVideoFrameFormat::operator ==(const QVideoFrameFormat &other) const
{
    return d == other.d || *d == *other.d;
}
 
bool QVideoFrameFormat::operator !=(const QVideoFrameFormat &other) const
{
    return d != other.d && !(*d == *other.d);
}
 
void QVideoFrameFormat::detach()
{
    d.detach();
}
 
QVideoFrameFormat::PixelFormat QVideoFrameFormat::pixelFormat() const
{
    return d->pixelFormat;
}
 
QSize QVideoFrameFormat::frameSize() const
{
    return d->frameSize;
}
 
int QVideoFrameFormat::frameWidth() const
{
    return d->frameSize.width();
}
 
int QVideoFrameFormat::frameHeight() const
{
    return d->frameSize.height();
}
 
int QVideoFrameFormat::planeCount() const
{
    return QVideoTextureHelper::textureDescription(d->pixelFormat)->nplanes;
}
 
void QVideoFrameFormat::setFrameSize(const QSize &size)
{
    detach();
    d->frameSize = size;
    d->viewport = QRect(QPoint(0, 0), size);
}
 
void QVideoFrameFormat::setFrameSize(int width, int height)
{
    detach();
    d->frameSize = QSize(width, height);
    d->viewport = QRect(0, 0, width, height);
}
 
QRect QVideoFrameFormat::viewport() const
{
    return d->viewport;
}
 
void QVideoFrameFormat::setViewport(const QRect &viewport)
{
    detach();
    d->viewport = viewport;
}
 
QVideoFrameFormat::Direction QVideoFrameFormat::scanLineDirection() const
{
    return d->scanLineDirection;
}
 
void QVideoFrameFormat::setScanLineDirection(Direction direction)
{
    detach();
    d->scanLineDirection = direction;
}
 
#if QT_DEPRECATED_SINCE(6, 8)
qreal QVideoFrameFormat::frameRate() const
{
    return streamFrameRate();
}
 
void QVideoFrameFormat::setFrameRate(qreal rate)
{
    setStreamFrameRate(rate);
}
#endif
 
qreal QVideoFrameFormat::streamFrameRate() const
{
    return d->frameRate;
}
 
void QVideoFrameFormat::setStreamFrameRate(qreal rate)
{
    detach();
    d->frameRate = rate;
}
 
#if QT_DEPRECATED_SINCE(6, 4)
QVideoFrameFormat::YCbCrColorSpace QVideoFrameFormat::yCbCrColorSpace() const
{
    return YCbCrColorSpace(d->colorSpace);
}
 
void QVideoFrameFormat::setYCbCrColorSpace(QVideoFrameFormat::YCbCrColorSpace space)
{
    detach();
    d->colorSpace = ColorSpace(space);
}
#endif // QT_DEPRECATED_SINCE(6, 4)
 
QVideoFrameFormat::ColorSpace QVideoFrameFormat::colorSpace() const
{
    return d->colorSpace;
}
 
void QVideoFrameFormat::setColorSpace(ColorSpace colorSpace)
{
    detach();
    d->colorSpace = colorSpace;
}
 
QVideoFrameFormat::ColorTransfer QVideoFrameFormat::colorTransfer() const
{
    return d->colorTransfer;
}
 
void QVideoFrameFormat::setColorTransfer(ColorTransfer colorTransfer)
{
    detach();
    d->colorTransfer = colorTransfer;
}
 
QVideoFrameFormat::ColorRange QVideoFrameFormat::colorRange() const
{
    return d->colorRange;
}
 
void QVideoFrameFormat::setColorRange(ColorRange range)
{
    detach();
    d->colorRange = range;
}
 
bool QVideoFrameFormat::isMirrored() const
{
    return d->mirrored;
}
 
void QVideoFrameFormat::setMirrored(bool mirrored)
{
    detach();
    d->mirrored = mirrored;
}
 
QtVideo::Rotation QVideoFrameFormat::rotation() const
{
    return d->rotation;
}
 
void QVideoFrameFormat::setRotation(QtVideo::Rotation rotation)
{
    detach();
    d->rotation = rotation;
}
 
QString QVideoFrameFormat::vertexShaderFileName() const
{
    return QVideoTextureHelper::vertexShaderFileName(*this);
}
 
QString QVideoFrameFormat::fragmentShaderFileName() const
{
    return QVideoTextureHelper::fragmentShaderFileName(*this);
}
 
void QVideoFrameFormat::updateUniformData(QByteArray *dst, const QVideoFrame &frame, const QMatrix4x4 &transform, float opacity) const
{
    QVideoTextureHelper::updateUniformData(dst, *this, frame, transform, opacity);
}
 
float QVideoFrameFormat::maxLuminance() const
{
    if (d->maxLuminance <= 0) {
        if (d->colorTransfer == ColorTransfer_ST2084)
            return 10000.; // ST2084 can encode up to 10000 nits
        if (d->colorTransfer == ColorTransfer_STD_B67)
            return 1500.; // SRD_B67 can encode up to 1200 nits, use a bit more for some headroom
        return 100; // SDR
    }
    return d->maxLuminance;
}
void QVideoFrameFormat::setMaxLuminance(float lum)
{
    detach();
    d->maxLuminance = lum;
}
 
 
QVideoFrameFormat::PixelFormat QVideoFrameFormat::pixelFormatFromImageFormat(QImage::Format format)
{
    switch (format) {
#if Q_BYTE_ORDER == Q_LITTLE_ENDIAN
    case QImage::Format_RGB32:
        return QVideoFrameFormat::Format_BGRX8888;
    case QImage::Format_ARGB32:
        return QVideoFrameFormat::Format_BGRA8888;
    case QImage::Format_ARGB32_Premultiplied:
        return QVideoFrameFormat::Format_BGRA8888_Premultiplied;
#else
    case QImage::Format_RGB32:
        return QVideoFrameFormat::Format_XRGB8888;
    case QImage::Format_ARGB32:
        return QVideoFrameFormat::Format_ARGB8888;
    case QImage::Format_ARGB32_Premultiplied:
        return QVideoFrameFormat::Format_ARGB8888_Premultiplied;
#endif
    case QImage::Format_RGBA8888:
        return QVideoFrameFormat::Format_RGBA8888;
    case QImage::Format_RGBA8888_Premultiplied:
        // QVideoFrameFormat::Format_RGBA8888_Premultiplied is to be added in 6.8
        // Format_RGBX8888 suits the best as a workaround
        return QVideoFrameFormat::Format_RGBX8888;
    case QImage::Format_RGBX8888:
        return QVideoFrameFormat::Format_RGBX8888;
    case QImage::Format_Grayscale8:
        return QVideoFrameFormat::Format_Y8;
    case QImage::Format_Grayscale16:
        return QVideoFrameFormat::Format_Y16;
    default:
        return QVideoFrameFormat::Format_Invalid;
    }
}
 
QImage::Format QVideoFrameFormat::imageFormatFromPixelFormat(QVideoFrameFormat::PixelFormat format)
{
    switch (format) {
#if Q_BYTE_ORDER == Q_LITTLE_ENDIAN
    case QVideoFrameFormat::Format_BGRA8888:
        return QImage::Format_ARGB32;
    case QVideoFrameFormat::Format_BGRA8888_Premultiplied:
        return QImage::Format_ARGB32_Premultiplied;
    case QVideoFrameFormat::Format_BGRX8888:
        return QImage::Format_RGB32;
    case QVideoFrameFormat::Format_ARGB8888:
    case QVideoFrameFormat::Format_ARGB8888_Premultiplied:
    case QVideoFrameFormat::Format_XRGB8888:
        return QImage::Format_Invalid;
#else
    case QVideoFrameFormat::Format_ARGB8888:
        return QImage::Format_ARGB32;
    case QVideoFrameFormat::Format_ARGB8888_Premultiplied:
        return QImage::Format_ARGB32_Premultiplied;
    case QVideoFrameFormat::Format_XRGB8888:
        return QImage::Format_RGB32;
    case QVideoFrameFormat::Format_BGRA8888:
    case QVideoFrameFormat::Format_BGRA8888_Premultiplied:
    case QVideoFrameFormat::Format_BGRX8888:
        return QImage::Format_Invalid;
#endif
    case QVideoFrameFormat::Format_RGBA8888:
        return QImage::Format_RGBA8888;
    case QVideoFrameFormat::Format_RGBX8888:
        return QImage::Format_RGBX8888;
    case QVideoFrameFormat::Format_Y8:
        return QImage::Format_Grayscale8;
    case QVideoFrameFormat::Format_Y16:
        return QImage::Format_Grayscale16;
    case QVideoFrameFormat::Format_ABGR8888:
    case QVideoFrameFormat::Format_XBGR8888:
    case QVideoFrameFormat::Format_AYUV:
    case QVideoFrameFormat::Format_AYUV_Premultiplied:
    case QVideoFrameFormat::Format_YUV420P:
    case QVideoFrameFormat::Format_YUV420P10:
    case QVideoFrameFormat::Format_YUV422P:
    case QVideoFrameFormat::Format_YV12:
    case QVideoFrameFormat::Format_UYVY:
    case QVideoFrameFormat::Format_YUYV:
    case QVideoFrameFormat::Format_NV12:
    case QVideoFrameFormat::Format_NV21:
    case QVideoFrameFormat::Format_IMC1:
    case QVideoFrameFormat::Format_IMC2:
    case QVideoFrameFormat::Format_IMC3:
    case QVideoFrameFormat::Format_IMC4:
    case QVideoFrameFormat::Format_P010:
    case QVideoFrameFormat::Format_P016:
    case QVideoFrameFormat::Format_Jpeg:
    case QVideoFrameFormat::Format_Invalid:
    case QVideoFrameFormat::Format_SamplerExternalOES:
    case QVideoFrameFormat::Format_SamplerRect:
        return QImage::Format_Invalid;
    }
    return QImage::Format_Invalid;
}
 
QString QVideoFrameFormat::pixelFormatToString(QVideoFrameFormat::PixelFormat pixelFormat)
{
    switch (pixelFormat) {
    case QVideoFrameFormat::Format_Invalid:
        return QStringLiteral("Invalid");
    case QVideoFrameFormat::Format_ARGB8888:
        return QStringLiteral("ARGB8888");
    case QVideoFrameFormat::Format_ARGB8888_Premultiplied:
        return QStringLiteral("ARGB8888 Premultiplied");
    case QVideoFrameFormat::Format_XRGB8888:
        return QStringLiteral("XRGB8888");
    case QVideoFrameFormat::Format_BGRA8888:
        return QStringLiteral("BGRA8888");
    case QVideoFrameFormat::Format_BGRX8888:
        return QStringLiteral("BGRX8888");
    case QVideoFrameFormat::Format_BGRA8888_Premultiplied:
        return QStringLiteral("BGRA8888 Premultiplied");
    case QVideoFrameFormat::Format_RGBA8888:
        return QStringLiteral("RGBA8888");
    case QVideoFrameFormat::Format_RGBX8888:
        return QStringLiteral("RGBX8888");
    case QVideoFrameFormat::Format_ABGR8888:
        return QStringLiteral("ABGR8888");
    case QVideoFrameFormat::Format_XBGR8888:
        return QStringLiteral("XBGR8888");
    case QVideoFrameFormat::Format_AYUV:
        return QStringLiteral("AYUV");
    case QVideoFrameFormat::Format_AYUV_Premultiplied:
        return QStringLiteral("AYUV Premultiplied");
    case QVideoFrameFormat::Format_YUV420P:
        return QStringLiteral("YUV420P");
    case QVideoFrameFormat::Format_YUV420P10:
        return QStringLiteral("YUV420P10");
    case QVideoFrameFormat::Format_YUV422P:
        return QStringLiteral("YUV422P");
    case QVideoFrameFormat::Format_YV12:
        return QStringLiteral("YV12");
    case QVideoFrameFormat::Format_UYVY:
        return QStringLiteral("UYVY");
    case QVideoFrameFormat::Format_YUYV:
        return QStringLiteral("YUYV");
    case QVideoFrameFormat::Format_NV12:
        return QStringLiteral("NV12");
    case QVideoFrameFormat::Format_NV21:
        return QStringLiteral("NV21");
    case QVideoFrameFormat::Format_IMC1:
        return QStringLiteral("IMC1");
    case QVideoFrameFormat::Format_IMC2:
        return QStringLiteral("IMC2");
    case QVideoFrameFormat::Format_IMC3:
        return QStringLiteral("IMC3");
    case QVideoFrameFormat::Format_IMC4:
        return QStringLiteral("IMC4");
    case QVideoFrameFormat::Format_Y8:
        return QStringLiteral("Y8");
    case QVideoFrameFormat::Format_Y16:
        return QStringLiteral("Y16");
    case QVideoFrameFormat::Format_P010:
        return QStringLiteral("P010");
    case QVideoFrameFormat::Format_P016:
        return QStringLiteral("P016");
    case QVideoFrameFormat::Format_SamplerExternalOES:
        return QStringLiteral("SamplerExternalOES");
    case QVideoFrameFormat::Format_Jpeg:
        return QStringLiteral("Jpeg");
    case QVideoFrameFormat::Format_SamplerRect:
        return QStringLiteral("SamplerRect");
    }
 
    return QStringLiteral("");
}
 
#ifndef QT_NO_DEBUG_STREAM
# if QT_DEPRECATED_SINCE(6, 4)
QDebug operator<<(QDebug dbg, QVideoFrameFormat::YCbCrColorSpace cs)
{
    QDebugStateSaver saver(dbg);
    dbg.nospace();
    switch (cs) {
        case QVideoFrameFormat::YCbCr_BT601:
            dbg << "YCbCr_BT601";
            break;
        case QVideoFrameFormat::YCbCr_BT709:
            dbg << "YCbCr_BT709";
            break;
        case QVideoFrameFormat::YCbCr_JPEG:
            dbg << "YCbCr_JPEG";
            break;
        case QVideoFrameFormat::YCbCr_xvYCC601:
            dbg << "YCbCr_xvYCC601";
            break;
        case QVideoFrameFormat::YCbCr_xvYCC709:
            dbg << "YCbCr_xvYCC709";
            break;
        case QVideoFrameFormat::YCbCr_BT2020:
            dbg << "YCbCr_BT2020";
            break;
        default:
            dbg << "YCbCr_Undefined";
            break;
    }
    return dbg;
}
# endif // QT_DEPRECATED_SINCE(6, 4)
 
QDebug operator<<(QDebug dbg, QVideoFrameFormat::ColorSpace cs)
{
    QDebugStateSaver saver(dbg);
    dbg.nospace();
    switch (cs) {
        case QVideoFrameFormat::ColorSpace_BT601:
            dbg << "ColorSpace_BT601";
            break;
        case QVideoFrameFormat::ColorSpace_BT709:
            dbg << "ColorSpace_BT709";
            break;
        case QVideoFrameFormat::ColorSpace_AdobeRgb:
            dbg << "ColorSpace_AdobeRgb";
            break;
        case QVideoFrameFormat::ColorSpace_BT2020:
            dbg << "ColorSpace_BT2020";
            break;
        default:
            dbg << "ColorSpace_Undefined";
            break;
    }
    return dbg;
}
 
QDebug operator<<(QDebug dbg, QVideoFrameFormat::Direction dir)
{
    QDebugStateSaver saver(dbg);
    dbg.nospace();
    switch (dir) {
        case QVideoFrameFormat::BottomToTop:
            dbg << "BottomToTop";
            break;
        case QVideoFrameFormat::TopToBottom:
            dbg << "TopToBottom";
            break;
    }
    return dbg;
}
 
QDebug operator<<(QDebug dbg, const QVideoFrameFormat &f)
{
    QDebugStateSaver saver(dbg);
    dbg.nospace();
    dbg << "QVideoFrameFormat(" << f.pixelFormat() << ", " << f.frameSize()
        << ", viewport=" << f.viewport()
        <<  ", colorSpace=" << f.colorSpace()
        << ')'
        << "\n    pixel format=" << f.pixelFormat()
        << "\n    frame size=" << f.frameSize()
        << "\n    viewport=" << f.viewport()
        << "\n    colorSpace=" << f.colorSpace()
        << "\n    frameRate=" << f.streamFrameRate()
        << "\n    mirrored=" << f.isMirrored();
 
    return dbg;
}
 
QDebug operator<<(QDebug dbg, QVideoFrameFormat::PixelFormat pf)
{
    QDebugStateSaver saver(dbg);
    dbg.nospace();
 
    auto format = QVideoFrameFormat::pixelFormatToString(pf);
    if (format.isEmpty())
        return dbg;
 
    dbg.noquote() << QStringLiteral("Format_") << format;
    return dbg;
}
#endif
 
QT_END_NAMESPACE