// 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 <QtMultimedia/private/qvideotexturehelper_p.h>
#include <QtMultimedia/private/qvideotransformation_p.h>
#include <QtMultimedia/private/qmultimedia_enum_to_string_converter_p.h>

#include <qdebug.h>
#include <qlist.h>
#include <qmetatype.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
            && transformation == other.transformation)
            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.;
    VideoTransformation transformation;
};

QT_DEFINE_QESDP_SPECIALIZATION_DTOR(QVideoFrameFormatPrivate);

/*!
    \class QVideoFrameFormat
    \brief The QVideoFrameFormat class specifies the stream format of a video presentation
    surface.
    \inmodule QtMultimedia

    \ingroup multimedia
    \ingroup multimedia_video

    A video sink presents a stream of video frames.  QVideoFrameFormat describes the type of
    the frames and determines how they should be presented.

    The core properties of a video stream required to set up a video sink are the pixel format
    given by pixelFormat(), and the frame dimensions given by frameSize().

    The region of a frame that is actually displayed on a video surface is given by the viewport().
    A stream may have a viewport less than the entire region of a frame to allow for videos smaller
    than the nearest optimal size of a video frame.  For example the width of a frame may be
    extended so that the start of each scan line is eight byte aligned.

    Other common properties are the scanLineDirection(), frameRate() and the yCrCbColorSpace().
*/

/*!
    \enum QVideoFrameFormat::PixelFormat

    Enumerates video data types.

    \value Format_Invalid
    The frame is invalid.

    \value Format_ARGB8888
    The frame is stored using a ARGB format with 8 bits per component.

    \value Format_ARGB8888_Premultiplied
    The frame stored using a premultiplied ARGB format with 8 bits per component.

    \value Format_XRGB8888
    The frame stored using a 32 bits per pixel RGB format (0xff, R, G, B).

    \value Format_BGRA8888
    The frame is stored using a 32-bit BGRA format (0xBBGGRRAA).

    \value Format_BGRA8888_Premultiplied
    The frame is stored using a premultiplied 32bit BGRA format.

    \value Format_ABGR8888
    The frame is stored using a 32-bit ABGR format (0xAABBGGRR).

    \value Format_XBGR8888
    The frame is stored using a 32-bit BGR format (0xffBBGGRR).

    \value Format_RGBA8888
    The frame is stored in memory as the bytes R, G, B, A/X, with R at the lowest address and A/X at the highest address.

    \value Format_BGRX8888
    The frame is stored in format 32-bit BGRx format, [31:0] B:G:R:x 8:8:8:8 little endian

    \value Format_RGBX8888
    The frame is stored in memory as the bytes R, G, B, A/X, with R at the lowest address and A/X at the highest address.

    \value Format_AYUV
    The frame is stored using a packed 32-bit AYUV format (0xAAYYUUVV).

    \value Format_AYUV_Premultiplied
    The frame is stored using a packed premultiplied 32-bit AYUV format (0xAAYYUUVV).

    \value Format_YUV420P
    The frame is stored using an 8-bit per component planar YUV format with the U and V planes
    horizontally and vertically sub-sampled, i.e. the height and width of the U and V planes are
    half that of the Y plane.

    \value Format_YUV422P
    The frame is stored using an 8-bit per component planar YUV format with the U and V planes
    horizontally sub-sampled, i.e. the width of the U and V planes are
    half that of the Y plane, and height of U and V planes is the same as Y.

    \value Format_YV12
    The frame is stored using an 8-bit per component planar YVU format with the V and U planes
    horizontally and vertically sub-sampled, i.e. the height and width of the V and U planes are
    half that of the Y plane.

    \value Format_UYVY
    The frame is stored using an 8-bit per component packed YUV format with the U and V planes
    horizontally sub-sampled (U-Y-V-Y), i.e. two horizontally adjacent pixels are stored as a 32-bit
    macropixel which has a Y value for each pixel and common U and V values.

    \value Format_YUYV
    The frame is stored using an 8-bit per component packed YUV format with the U and V planes
    horizontally sub-sampled (Y-U-Y-V), i.e. two horizontally adjacent pixels are stored as a 32-bit
    macropixel which has a Y value for each pixel and common U and V values.

    \value Format_NV12
    The frame is stored using an 8-bit per component semi-planar YUV format with a Y plane (Y)
    followed by a horizontally and vertically sub-sampled, packed UV plane (U-V).

    \value Format_NV21
    The frame is stored using an 8-bit per component semi-planar YUV format with a Y plane (Y)
    followed by a horizontally and vertically sub-sampled, packed VU plane (V-U).

    \value Format_IMC1
    The frame is stored using an 8-bit per component planar YUV format with the U and V planes
    horizontally and vertically sub-sampled.  This is similar to the Format_YUV420P type, except
    that the bytes per line of the U and V planes are padded out to the same stride as the Y plane.

    \value Format_IMC2
    The frame is stored using an 8-bit per component planar YUV format with the U and V planes
    horizontally and vertically sub-sampled.  This is similar to the Format_YUV420P type, except
    that the lines of the U and V planes are interleaved, i.e. each line of U data is followed by a
    line of V data creating a single line of the same stride as the Y data.

    \value Format_IMC3
    The frame is stored using an 8-bit per component planar YVU format with the V and U planes
    horizontally and vertically sub-sampled.  This is similar to the Format_YV12 type, except that
    the bytes per line of the V and U planes are padded out to the same stride as the Y plane.

    \value Format_IMC4
    The frame is stored using an 8-bit per component planar YVU format with the V and U planes
    horizontally and vertically sub-sampled.  This is similar to the Format_YV12 type, except that
    the lines of the V and U planes are interleaved, i.e. each line of V data is followed by a line
    of U data creating a single line of the same stride as the Y data.

    \value Format_P010
    The frame is stored using a 16bit per component semi-planar YUV format with a Y plane (Y)
    followed by a horizontally and vertically sub-sampled, packed UV plane (U-V). Only the 10 most
    significant bits of each component are being used.

    \value Format_P016
    The frame is stored using a 16bit per component semi-planar YUV format with a Y plane (Y)
    followed by a horizontally and vertically sub-sampled, packed UV plane (U-V).

    \value Format_Y8
    The frame is stored using an 8-bit greyscale format.

    \value Format_Y16
    The frame is stored using a 16-bit linear greyscale format.  Little endian.

    \value Format_Jpeg
    The frame is stored in compressed Jpeg format.

    \value Format_SamplerExternalOES
    The frame is stored in external OES texture format. This is currently only being used on Android.

    \value Format_SamplerRect
    The frame is stored in rectangle texture format (GL_TEXTURE_RECTANGLE). This is only being used on
    macOS with an OpenGL based Rendering Hardware interface. The underlying pixel format stored in the
    texture is Format_BRGA8888.

    \value Format_YUV420P10
    Similar to YUV420, but uses 16bits per component, 10 of those significant.
*/

/*!
    \enum QVideoFrameFormat::Direction

    Enumerates the layout direction of video scan lines.

    \value TopToBottom Scan lines are arranged from the top of the frame to the bottom.
    \value BottomToTop Scan lines are arranged from the bottom of the frame to the top.
*/

/*!
    \enum QVideoFrameFormat::YCbCrColorSpace

    \deprecated Use QVideoFrameFormat::ColorSpace instead.

    Enumerates the Y'CbCr color space of video frames.

    \value YCbCr_Undefined
    No color space is specified.

    \value YCbCr_BT601
    A Y'CbCr color space defined by ITU-R recommendation BT.601
    with Y value range from 16 to 235, and Cb/Cr range from 16 to 240.
    Used mostly by older videos that were targeting CRT displays.

    \value YCbCr_BT709
    A Y'CbCr color space defined by ITU-R BT.709 with the same values range as YCbCr_BT601.
    The most commonly used color space today.

    \value YCbCr_xvYCC601
    This value is deprecated. Please check the \l ColorRange instead.
    The BT.601 color space with the value range extended to 0 to 255.
    It is backward compatible with BT.601 and uses values outside BT.601 range to represent a
    wider range of colors.

    \value YCbCr_xvYCC709
    This value is deprecated. Please check the \l ColorRange instead.
    The BT.709 color space with the value range extended to 0 to 255.

    \value YCbCr_JPEG
    The full range Y'CbCr color space used in most JPEG files.

    \value YCbCr_BT2020
    The color space defined by ITU-R BT.2020. Used mainly for HDR videos.
*/


/*!
    \enum QVideoFrameFormat::ColorSpace

    Enumerates the color space of video frames.

    \value ColorSpace_Undefined
    No color space is specified.

    \value ColorSpace_BT601
    A color space defined by ITU-R recommendation BT.601
    with Y value range from 16 to 235, and Cb/Cr range from 16 to 240.
    Used mostly by older videos that were targeting CRT displays.

    \value ColorSpace_BT709
    A color space defined by ITU-R BT.709 with the same values range as ColorSpace_BT601.
    The most commonly used color space today.

    \value ColorSpace_AdobeRgb
    The full range YUV color space used in most JPEG files.

    \value ColorSpace_BT2020
    The color space defined by ITU-R BT.2020. Used mainly for HDR videos.
*/

/*!
    \enum QVideoFrameFormat::ColorTransfer

    \value ColorTransfer_Unknown
    The color transfer function is unknown.

    \value ColorTransfer_BT709
    Color values are encoded according to BT709. See also https://www.itu.int/rec/R-REC-BT.709/en.
    This is close to, but not identical to a gamma curve of 2.2, and the same transfer curve as is
    used in sRGB.

    \value ColorTransfer_BT601
    Color values are encoded according to BT601. See also https://www.itu.int/rec/R-REC-BT.601/en.

    \value ColorTransfer_Linear
    Color values are linear

    \value ColorTransfer_Gamma22
    Color values are encoded with a gamma of 2.2

    \value ColorTransfer_Gamma28
    Color values are encoded with a gamma of 2.8

    \value ColorTransfer_ST2084
    Color values are encoded using STME ST 2084. This transfer function is the most common HDR
    transfer function and often called the 'perceptual quantizer'. See also https://www.itu.int/rec/R-REC-BT.2100
    and https://en.wikipedia.org/wiki/Perceptual_quantizer.


    \value ColorTransfer_STD_B67
    Color values are encoded using ARIB STD B67. This transfer function is also often referred to as 'hybrid log gamma'.
    See also https://www.itu.int/rec/R-REC-BT.2100 and https://en.wikipedia.org/wiki/Hybrid_log–gamma.
*/

/*!
    \enum QVideoFrameFormat::ColorRange

    Describes the color range used by the video data. Video data usually comes in either full
    color range, where all values are being used, or a more limited range traditionally used in
    YUV video formats, where a subset of all values is being used.

    \value ColorRange_Unknown
    The color range of the video is unknown.

    \value ColorRange_Video

    The color range traditionally used by most YUV video formats. For 8 bit formats, the Y component is
    limited to values between 16 and 235. The U and V components are limited to values between 16 and 240

    For higher bit depths multiply these values with 2^(depth-8).

    \value ColorRange_Full

    Full color range. All values from 0 to 2^depth - 1 are valid.
*/

/*!
    Constructs a null video stream format.
*/
QVideoFrameFormat::QVideoFrameFormat()
    : d(new QVideoFrameFormatPrivate)
{
    initResource();
}

/*!
    Constructs a video stream with the given frame \a size and pixel \a format.
*/
QVideoFrameFormat::QVideoFrameFormat(
        const QSize& size, QVideoFrameFormat::PixelFormat format)
    : d(new QVideoFrameFormatPrivate(size, format))
{
}

/*!
    Constructs a copy of \a other.
*/
QVideoFrameFormat::QVideoFrameFormat(const QVideoFrameFormat &other) = default;

/*!
    \fn QVideoFrameFormat::QVideoFrameFormat(QVideoFrameFormat &&other)

    Constructs a QVideoFrameFormat by moving from \a other.
*/

/*!
    \fn void QVideoFrameFormat::swap(QVideoFrameFormat &other) noexcept

    Swaps the current video frame format with the \a other.
*/

/*!
    Assigns the values of \a other to this object.
*/
QVideoFrameFormat &QVideoFrameFormat::operator =(const QVideoFrameFormat &other) = default;

/*!
    \fn QVideoFrameFormat &QVideoFrameFormat::operator =(QVideoFrameFormat &&other)

    Moves \a other into this QVideoFrameFormat.
*/

/*!
    Destroys a video stream description.
*/
QVideoFrameFormat::~QVideoFrameFormat() = default;

/*!
    Identifies if a video surface format has a valid pixel format and frame size.

    Returns true if the format is valid, and false otherwise.
*/
bool QVideoFrameFormat::isValid() const
{
    return d->pixelFormat != Format_Invalid && d->frameSize.isValid();
}

/*!
    Returns true if \a other is the same as this video format, and false if they are different.
*/
bool QVideoFrameFormat::operator ==(const QVideoFrameFormat &other) const
{
    return d == other.d || *d == *other.d;
}

/*!
    Returns true if \a other is different to this video format, and false if they are the same.
*/
bool QVideoFrameFormat::operator !=(const QVideoFrameFormat &other) const
{
    return d != other.d && !(*d == *other.d);
}

/*!
    \internal
*/
void QVideoFrameFormat::detach()
{
    d.detach();
}

/*!
    Returns the pixel format of frames in a video stream.
*/
QVideoFrameFormat::PixelFormat QVideoFrameFormat::pixelFormat() const
{
    return d->pixelFormat;
}

/*!
    Returns the dimensions of frames in a video stream.

    \sa frameWidth(), frameHeight()
*/
QSize QVideoFrameFormat::frameSize() const
{
    return d->frameSize;
}

/*!
    Returns the width of frames in a video stream.

    \sa frameSize(), frameHeight()
*/
int QVideoFrameFormat::frameWidth() const
{
    return d->frameSize.width();
}

/*!
    Returns the height of frame in a video stream.
*/
int QVideoFrameFormat::frameHeight() const
{
    return d->frameSize.height();
}

/*!
    Returns the number of planes used.
    This number is depending on the pixel format and is
    1 for RGB based formats, and a number between 1 and 3 for
    YUV based formats.
*/
int QVideoFrameFormat::planeCount() const
{
    return QVideoTextureHelper::textureDescription(d->pixelFormat)->nplanes;
}

/*!
    Sets the size of frames in a video stream to \a size.

    This will reset the viewport() to fill the entire frame.
*/
void QVideoFrameFormat::setFrameSize(const QSize &size)
{
    detach();
    d->frameSize = size;
    d->viewport = QRect(QPoint(0, 0), size);
}

/*!
    \overload

    Sets the \a width and \a height of frames in a video stream.

    This will reset the viewport() to fill the entire frame.
*/
void QVideoFrameFormat::setFrameSize(int width, int height)
{
    detach();
    d->frameSize = QSize(width, height);
    d->viewport = QRect(0, 0, width, height);
}

/*!
    Returns the viewport of a video stream.

    The viewport is the region of a video frame that is actually displayed.

    By default the viewport covers an entire frame.
*/
QRect QVideoFrameFormat::viewport() const
{
    return d->viewport;
}

/*!
    Sets the viewport of a video stream to \a viewport.
*/
void QVideoFrameFormat::setViewport(const QRect &viewport)
{
    detach();
    d->viewport = viewport;
}

/*!
    Returns the direction of scan lines.
*/
QVideoFrameFormat::Direction QVideoFrameFormat::scanLineDirection() const
{
    return d->scanLineDirection;
}

/*!
    Sets the \a direction of scan lines.
*/
void QVideoFrameFormat::setScanLineDirection(Direction direction)
{
    detach();
    d->scanLineDirection = direction;
}

#if QT_DEPRECATED_SINCE(6, 8)
/*!
    Returns the frame rate of a video stream in frames per second.
*/
qreal QVideoFrameFormat::frameRate() const
{
    return streamFrameRate();
}

/*!
    Sets the frame \a rate of a video stream in frames per second.
*/
void QVideoFrameFormat::setFrameRate(qreal rate)
{
    setStreamFrameRate(rate);
}
#endif

/*!
    Returns the frame rate of a video stream in frames per second.
*/
qreal QVideoFrameFormat::streamFrameRate() const
{
    return d->frameRate;
}

/*!
    Sets the frame \a rate of a video stream in frames per second.
*/
void QVideoFrameFormat::setStreamFrameRate(qreal rate)
{
    detach();
    d->frameRate = rate;
}

#if QT_DEPRECATED_SINCE(6, 4)
/*!
    \deprecated Use colorSpace() instead

    Returns the Y'CbCr color space of a video stream.
*/
QVideoFrameFormat::YCbCrColorSpace QVideoFrameFormat::yCbCrColorSpace() const
{
    return YCbCrColorSpace(d->colorSpace);
}

/*!
    \deprecated Use setColorSpace() instead

    Sets the Y'CbCr color \a space of a video stream.
    It is only used with raw YUV frame types.
*/
void QVideoFrameFormat::setYCbCrColorSpace(QVideoFrameFormat::YCbCrColorSpace space)
{
    detach();
    d->colorSpace = ColorSpace(space);
}
#endif // QT_DEPRECATED_SINCE(6, 4)

/*!
    Returns the color space of a video stream.
*/
QVideoFrameFormat::ColorSpace QVideoFrameFormat::colorSpace() const
{
    return d->colorSpace;
}

/*!
    Sets the \a colorSpace of a video stream.
*/
void QVideoFrameFormat::setColorSpace(ColorSpace colorSpace)
{
    detach();
    d->colorSpace = colorSpace;
}

/*!
    Returns the color transfer function that should be used to render the
    video stream.
*/
QVideoFrameFormat::ColorTransfer QVideoFrameFormat::colorTransfer() const
{
    return d->colorTransfer;
}

/*!
    Sets the color transfer function that should be used to render the
    video stream to \a colorTransfer.
*/
void QVideoFrameFormat::setColorTransfer(ColorTransfer colorTransfer)
{
    detach();
    d->colorTransfer = colorTransfer;
}

/*!
    Returns the color range that should be used to render the
    video stream.
*/
QVideoFrameFormat::ColorRange QVideoFrameFormat::colorRange() const
{
    return d->colorRange;
}

/*!
    Sets the color transfer range that should be used to render the
    video stream to \a range.
*/
void QVideoFrameFormat::setColorRange(ColorRange range)
{
    detach();
    d->colorRange = range;
}

/*!
    Returns \c true if the surface is mirrored around its vertical axis.

    Transformations of \c QVideoFrameFormat, specifically,
    rotation and mirroring, can be determined by the orientation of
    the camera sensor, camera settings, or the orientation of
    the video stream.

    Mirroring is applied after rotation.

    \note The mirroring here differs from QImage::mirrored, as a vertically mirrored QImage
    will be mirrored around its x-axis.

    \since 5.11
 */
bool QVideoFrameFormat::isMirrored() const
{
    return d->transformation.mirroredHorizontallyAfterRotation;
}

/*!
    Sets if the surface is \a mirrored around its vertical axis.

    Transformations of \c QVideoFrameFormat, specifically,
    rotation and mirroring, can be determined by the orientation of
    the camera sensor, camera settings, or the orientation of
    the video stream.

    Mirroring is applied after rotation.

    Default value is \c false.

    \note The mirroring here differs from QImage::mirrored, as a vertically mirrored QImage
    will be mirrored around its x-axis.

    \since 5.11
 */
void QVideoFrameFormat::setMirrored(bool mirrored)
{
    detach();
    d->transformation.mirroredHorizontallyAfterRotation = mirrored;
}

/*!
    Returns the angle by which the surface is rotated clockwise.

    Transformations of \c QVideoFrameFormat, specifically,
    rotation and mirroring, can be determined by the orientation of
    the camera sensor, camera settings, or the orientation of
    the video stream.

    Rotation is applied before mirroring.
 */
QtVideo::Rotation QVideoFrameFormat::rotation() const
{
    return d->transformation.rotation;
}

/*!
    Sets the \a angle by which the surface is rotated clockwise.

    Transformations of \c QVideoFrameFormat, specifically,
    rotation and mirroring, can be determined by the orientation of
    the camera sensor, camera settings, or the orientation of
    the video stream.

    Rotation is applied before mirroring.

    Default value is \c QtVideo::Rotation::None.
 */
void QVideoFrameFormat::setRotation(QtVideo::Rotation angle)
{
    detach();
    d->transformation.rotation = angle;
}

/*!
    \internal
*/
QString QVideoFrameFormat::vertexShaderFileName() const
{
    return QVideoTextureHelper::vertexShaderFileName(*this);
}

/*!
    \internal
*/
QString QVideoFrameFormat::fragmentShaderFileName() const
{
    return QVideoTextureHelper::fragmentShaderFileName(*this, nullptr);
}

/*!
    \internal
*/
void QVideoFrameFormat::updateUniformData(QByteArray *dst, const QVideoFrame &frame, const QMatrix4x4 &transform, float opacity) const
{
    QVideoTextureHelper::updateUniformData(dst, nullptr, *this, frame, transform, opacity);
}

/*!
    \internal

    The maximum luminence in nits as set by the HDR metadata. If the video doesn't have meta data, the returned value depends on the
    maximum that can be encoded by the transfer function.
*/
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;
}
/*!
    Sets the maximum luminance to the given value, \a lum.
*/
void QVideoFrameFormat::setMaxLuminance(float lum)
{
    detach();
    d->maxLuminance = lum;
}


/*!
    Returns a video pixel format equivalent to an image \a format.  If there is no equivalent
    format QVideoFrameFormat::Format_Invalid is returned instead.

    \note In general \l QImage does not handle YUV formats.

*/
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;
    }
}

/*!
    Returns an image format equivalent to a video frame pixel \a format.  If there is no equivalent
    format QImage::Format_Invalid is returned instead.

    \note In general \l QImage does not handle YUV formats.

*/
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;
}

// clang-format off

QT_MM_MAKE_STRING_RESOLVER(QVideoFrameFormat::PixelFormat, QtMultimediaPrivate::EnumName,
    (QVideoFrameFormat::Format_Invalid,                 "Invalid")
    (QVideoFrameFormat::Format_ARGB8888,                "ARGB8888")
    (QVideoFrameFormat::Format_ARGB8888_Premultiplied,  "ARGB8888 Premultiplied")
    (QVideoFrameFormat::Format_XRGB8888,                "XRGB8888")
    (QVideoFrameFormat::Format_BGRA8888,                "BGRA8888")
    (QVideoFrameFormat::Format_BGRX8888,                "BGRX8888")
    (QVideoFrameFormat::Format_BGRA8888_Premultiplied,  "BGRA8888 Premultiplied")
    (QVideoFrameFormat::Format_RGBA8888,                "RGBA8888")
    (QVideoFrameFormat::Format_RGBX8888,                "RGBX8888")
    (QVideoFrameFormat::Format_ABGR8888,                "ABGR8888")
    (QVideoFrameFormat::Format_XBGR8888,                "XBGR8888")
    (QVideoFrameFormat::Format_AYUV,                    "AYUV")
    (QVideoFrameFormat::Format_AYUV_Premultiplied,      "AYUV Premultiplied")
    (QVideoFrameFormat::Format_YUV420P,                 "YUV420P")
    (QVideoFrameFormat::Format_YUV420P10,               "YUV420P10")
    (QVideoFrameFormat::Format_YUV422P,                 "YUV422P")
    (QVideoFrameFormat::Format_YV12,                    "YV12")
    (QVideoFrameFormat::Format_UYVY,                    "UYVY")
    (QVideoFrameFormat::Format_YUYV,                    "YUYV")
    (QVideoFrameFormat::Format_NV12,                    "NV12")
    (QVideoFrameFormat::Format_NV21,                    "NV21")
    (QVideoFrameFormat::Format_IMC1,                    "IMC1")
    (QVideoFrameFormat::Format_IMC2,                    "IMC2")
    (QVideoFrameFormat::Format_IMC3,                    "IMC3")
    (QVideoFrameFormat::Format_IMC4,                    "IMC4")
    (QVideoFrameFormat::Format_Y8,                      "Y8")
    (QVideoFrameFormat::Format_Y16,                     "Y16")
    (QVideoFrameFormat::Format_P010,                    "P010")
    (QVideoFrameFormat::Format_P016,                    "P016")
    (QVideoFrameFormat::Format_SamplerExternalOES,      "SamplerExternalOES")
    (QVideoFrameFormat::Format_Jpeg,                    "Jpeg")
    (QVideoFrameFormat::Format_SamplerRect,             "SamplerRect")
);

#ifndef QT_NO_DEBUG_STREAM
# if QT_DEPRECATED_SINCE(6, 4)
QT_MM_MAKE_STRING_RESOLVER(QVideoFrameFormat::YCbCrColorSpace, QtMultimediaPrivate::EnumName,
    (QVideoFrameFormat::YCbCr_Undefined,   "YCbCr_Undefined")
    (QVideoFrameFormat::YCbCr_BT601,       "YCbCr_BT601")
    (QVideoFrameFormat::YCbCr_BT709,       "YCbCr_BT709")
    (QVideoFrameFormat::YCbCr_xvYCC601,    "YCbCr_xvYCC601")
    (QVideoFrameFormat::YCbCr_xvYCC709,    "YCbCr_xvYCC709")
    (QVideoFrameFormat::YCbCr_JPEG,        "YCbCr_JPEG")
    (QVideoFrameFormat::YCbCr_BT2020,      "YCbCr_BT2020")
);
QT_MM_DEFINE_QDEBUG_ENUM(QVideoFrameFormat::YCbCrColorSpace);
# endif // QT_DEPRECATED_SINCE(6, 4)

QT_MM_MAKE_STRING_RESOLVER(QVideoFrameFormat::ColorSpace, QtMultimediaPrivate::EnumName,
                           (QVideoFrameFormat::ColorSpace_BT601,     "ColorSpace_BT601")
                           (QVideoFrameFormat::ColorSpace_BT709,     "ColorSpace_BT709")
                           (QVideoFrameFormat::ColorSpace_AdobeRgb,  "ColorSpace_AdobeRgb")
                           (QVideoFrameFormat::ColorSpace_BT2020,    "ColorSpace_BT2020")
                           (QVideoFrameFormat::ColorSpace_Undefined, "ColorSpace_Undefined")
                           );
QT_MM_DEFINE_QDEBUG_ENUM(QVideoFrameFormat::ColorSpace);

QT_MM_MAKE_STRING_RESOLVER(QVideoFrameFormat::ColorTransfer, QtMultimediaPrivate::EnumName,
    (QVideoFrameFormat::ColorTransfer_Unknown,    "ColorTransfer_Unknown")
    (QVideoFrameFormat::ColorTransfer_BT709,      "ColorTransfer_BT709")
    (QVideoFrameFormat::ColorTransfer_BT601,      "ColorTransfer_BT601")
    (QVideoFrameFormat::ColorTransfer_Linear,     "ColorTransfer_Linear")
    (QVideoFrameFormat::ColorTransfer_Gamma22,    "ColorTransfer_Gamma22")
    (QVideoFrameFormat::ColorTransfer_Gamma28,    "ColorTransfer_Gamma28")
    (QVideoFrameFormat::ColorTransfer_ST2084,     "ColorTransfer_ST2084")
    (QVideoFrameFormat::ColorTransfer_STD_B67,    "ColorTransfer_STD_B67")
);
QT_MM_DEFINE_QDEBUG_ENUM(QVideoFrameFormat::ColorTransfer);

QT_MM_MAKE_STRING_RESOLVER(QVideoFrameFormat::ColorRange, QtMultimediaPrivate::EnumName,
    (QVideoFrameFormat::ColorRange_Unknown,   "ColorRange_Unknown")
    (QVideoFrameFormat::ColorRange_Video,     "ColorRange_Video")
    (QVideoFrameFormat::ColorRange_Full,      "ColorRange_Full")
);
QT_MM_DEFINE_QDEBUG_ENUM(QVideoFrameFormat::ColorRange);

QT_MM_MAKE_STRING_RESOLVER(QVideoFrameFormat::Direction, QtMultimediaPrivate::EnumName,
    (QVideoFrameFormat::TopToBottom,    "TopToBottom")
    (QVideoFrameFormat::BottomToTop,    "BottomToTop")
);
QT_MM_DEFINE_QDEBUG_ENUM(QVideoFrameFormat::Direction);

// clang-format off

/*!
    Returns a string representation of the given \a pixelFormat.
*/

Q_MULTIMEDIA_EXPORT QString QVideoFrameFormat::pixelFormatToString(QVideoFrameFormat::PixelFormat pixelFormat)
{
    auto str = QtMultimediaPrivate::StringResolver<QVideoFrameFormat::PixelFormat>::toQString(pixelFormat);
    return str.value_or(QString());
}

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()
        << "\n    range=" << f.colorRange()
        << "\n    colorTransfer=" << f.colorTransfer();

    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
