framegenerator_p.h

Go to the documentation of this file.

// Copyright (C) 2024 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only
 
#ifndef FRAMEGENERATOR_H
#define FRAMEGENERATOR_H
 
//
//  W A R N I N G
//  -------------
//
// This file is not part of the Qt API. It exists purely as an
// implementation detail. This header file may change from version to
// version without notice, or even be removed.
//
// We mean it.
//
 
#include <QtCore/qobject.h>
#include <QtMultimedia/qvideoframe.h>
 
#include <array>
#include <chrono>
 
QT_BEGIN_NAMESPACE
 
enum class ImagePattern
{
    SingleColor, // Image filled with a single color
    ColoredSquares // Colored squares, [red, green; blue, yellow]
};
 
class VideoGenerator : public QObject
{
    Q_OBJECT
public:
    void setPattern(ImagePattern pattern);
    void setFrameCount(int count);
    void setSize(QSize size);
    void setPixelFormat(QVideoFrameFormat::PixelFormat pixelFormat);
    void setFrameRate(double rate);
    void setPeriod(std::chrono::microseconds period);
    void setPresentationRotation(QtVideo::Rotation rotation);
    void setPresentationMirrored(bool mirror);
    void setEndTimeReporting(bool endTimeIsReported);
    void setColors(std::array<QColor, 5> colors);
    void emitEmptyFrameOnStop();
    QVideoFrame createFrame();
 
Q_SIGNALS:
    void done();
    void frameCreated(const QVideoFrame &frame);
 
public Q_SLOTS:
    void nextFrame();
 
private:
    std::array<QColor, 5> m_colors{
        QColorConstants::Red,   QColorConstants::Green, QColorConstants::Blue,
        QColorConstants::Black, QColorConstants::White,
    };
    ImagePattern m_pattern = ImagePattern::SingleColor;
    QSize m_size{ 640, 480 };
    QVideoFrameFormat::PixelFormat m_pixelFormat = QVideoFrameFormat::Format_BGRA8888;
    std::optional<int> m_maxFrameCount;
    int m_frameIndex = 0;
    std::optional<double> m_frameRate;
    std::optional<std::chrono::microseconds> m_period;
    std::optional<QtVideo::Rotation> m_presentationRotation;
    std::optional<bool> m_presentationMirrored;
    bool m_emitEmptyFrameOnStop = false;
    bool m_endTimeIsReported = true;
};
 
QT_END_NAMESPACE
 
#endif