qvideoframeformat.h

Enable keyboard shortcuts

// 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

#ifndef QVIDEOSURFACEFORMAT_H

#define QVIDEOSURFACEFORMAT_H

#include <QtMultimedia/qtmultimediaglobal.h>

#include <QtMultimedia/qtvideo.h>

#include <QtCore/qlist.h>

#include <QtCore/qmetatype.h>

#include <QtCore/qshareddata.h>

#include <QtCore/qsize.h>

#include <QtGui/qimage.h>

QT_BEGIN_NAMESPACE

class QDebug;

class QVideoFrameFormatPrivate;

class QVideoFrame;

class QMatrix4x4;

QT_DECLARE_QESDP_SPECIALIZATION_DTOR_WITH_EXPORT(QVideoFrameFormatPrivate, Q_MULTIMEDIA_EXPORT)

class Q_MULTIMEDIA_EXPORT QVideoFrameFormat

    Q_GADGET

public:

    enum PixelFormat

        Format_Invalid,

        Format_ARGB8888,

        Format_ARGB8888_Premultiplied,

        Format_XRGB8888,

        Format_BGRA8888,

        Format_BGRA8888_Premultiplied,

        Format_BGRX8888,

        Format_ABGR8888,

        Format_XBGR8888,

        Format_RGBA8888,

        Format_RGBX8888,

        Format_AYUV,

        Format_AYUV_Premultiplied,

        Format_YUV420P,

        Format_YUV422P,

        Format_YV12,

        Format_UYVY,

        Format_YUYV,

        Format_NV12,

        Format_NV21,

        Format_IMC1,

        Format_IMC2,

        Format_IMC3,

        Format_IMC4,

        Format_Y8,

        Format_Y16,

        Format_P010,

        Format_P016,

        Format_SamplerExternalOES,

        Format_Jpeg,

        Format_SamplerRect,

        Format_YUV420P10

};

    Q_ENUM(PixelFormat)

#ifndef Q_QDOC

    static constexpr int NPixelFormats = Format_YUV420P10 + 1;

#endif

    enum Direction

        TopToBottom,

        BottomToTop

};

    Q_ENUM(Direction)

#if QT_DEPRECATED_SINCE(6, 4)

    enum YCbCrColorSpace

        YCbCr_Undefined = 0,

        YCbCr_BT601 = 1,

        YCbCr_BT709 = 2,

        YCbCr_xvYCC601 = 3,

        YCbCr_xvYCC709 = 4,

        YCbCr_JPEG = 5,

        YCbCr_BT2020 = 6

};

    Q_ENUM(YCbCrColorSpace)

#endif

    // Keep values compatible with YCbCrColorSpace

    enum ColorSpace

        ColorSpace_Undefined = 0,

        ColorSpace_BT601 = 1,

        ColorSpace_BT709 = 2,

        ColorSpace_AdobeRgb = 5,

        ColorSpace_BT2020 = 6

};

    Q_ENUM(ColorSpace)

    enum ColorTransfer

        ColorTransfer_Unknown,

        ColorTransfer_BT709,

        ColorTransfer_BT601,

        ColorTransfer_Linear,

        ColorTransfer_Gamma22,

        ColorTransfer_Gamma28,

        ColorTransfer_ST2084,

        ColorTransfer_STD_B67,

};

    Q_ENUM(ColorTransfer)

    enum ColorRange

        ColorRange_Unknown,

        ColorRange_Video,

        ColorRange_Full

};

    Q_ENUM(ColorRange)

    QVideoFrameFormat();

    QVideoFrameFormat(const QSize &size, PixelFormat pixelFormat);

    QVideoFrameFormat(const QVideoFrameFormat &format);

    ~QVideoFrameFormat();

    QVideoFrameFormat(QVideoFrameFormat &&other) noexcept = default;

    QT_MOVE_ASSIGNMENT_OPERATOR_IMPL_VIA_PURE_SWAP(QVideoFrameFormat)

    void swap(QVideoFrameFormat &other) noexcept

    { d.swap(other.d); }

    void detach();

    QVideoFrameFormat &operator=(const QVideoFrameFormat &format);

    bool operator==(const QVideoFrameFormat &format) const;

    bool operator!=(const QVideoFrameFormat &format) const;

    bool isValid() const;

    QVideoFrameFormat::PixelFormat pixelFormat() const;

    QSize frameSize() const;

    void setFrameSize(const QSize &size);

    void setFrameSize(int width, int height);

    int frameWidth() const;

    int frameHeight() const;

    int planeCount() const;

    QRect viewport() const;

    void setViewport(const QRect &viewport);

    Direction scanLineDirection() const;

    void setScanLineDirection(Direction direction);

#if QT_DEPRECATED_SINCE(6, 8)

    QT_DEPRECATED_VERSION_X_6_8("Use streamFrameRate()")

    qreal frameRate() const;

    QT_DEPRECATED_VERSION_X_6_8("Use setStreamFrameRate()")

    void setFrameRate(qreal rate);

#endif

    qreal streamFrameRate() const;

    void setStreamFrameRate(qreal rate);

#if QT_DEPRECATED_SINCE(6, 4)

    QT_DEPRECATED_VERSION_X_6_4("Use colorSpace()")

    YCbCrColorSpace yCbCrColorSpace() const;

    QT_DEPRECATED_VERSION_X_6_4("Use setColorSpace()")

    void setYCbCrColorSpace(YCbCrColorSpace colorSpace);

#endif

    ColorSpace colorSpace() const;

    void setColorSpace(ColorSpace colorSpace);

    ColorTransfer colorTransfer() const;

    void setColorTransfer(ColorTransfer colorTransfer);

    ColorRange colorRange() const;

    void setColorRange(ColorRange range);

    bool isMirrored() const;

    void setMirrored(bool mirrored);

    QtVideo::Rotation rotation() const;

    void setRotation(QtVideo::Rotation rotation);

    QString vertexShaderFileName() const;

    QString fragmentShaderFileName() const;

    void updateUniformData(QByteArray *dst, const QVideoFrame &frame, const QMatrix4x4 &transform, float opacity) const;

    float maxLuminance() const;

    void setMaxLuminance(float lum);

    static PixelFormat pixelFormatFromImageFormat(QImage::Format format);

    static QImage::Format imageFormatFromPixelFormat(PixelFormat format);

    static QString pixelFormatToString(QVideoFrameFormat::PixelFormat pixelFormat);

private:

    QExplicitlySharedDataPointer<QVideoFrameFormatPrivate> d;

};

Q_DECLARE_SHARED(QVideoFrameFormat)

#ifndef QT_NO_DEBUG_STREAM

Q_MULTIMEDIA_EXPORT QDebug operator<<(QDebug, const QVideoFrameFormat &);

#endif

#if QT_MULTIMEDIA_REMOVED_SINCE(6, 11)

#  ifndef QT_NO_DEBUG_STREAM

Q_MULTIMEDIA_EXPORT QDebug operator<<(QDebug, QVideoFrameFormat::Direction);

#    if QT_DEPRECATED_SINCE(6, 4)

QT_DEPRECATED_VERSION_X_6_4("Use QVideoFrameFormat::ColorSpace")

Q_MULTIMEDIA_EXPORT QDebug operator<<(QDebug, QVideoFrameFormat::YCbCrColorSpace);

#    endif

Q_MULTIMEDIA_EXPORT QDebug operator<<(QDebug, QVideoFrameFormat::ColorSpace);

#  endif // QT_NO_DEBUG_STREAM

#endif // QT_MULTIMEDIA_REMOVED_SINCE(6, 11)

QT_END_NAMESPACE

Q_DECLARE_METATYPE(QVideoFrameFormat)

#endif