qgsvideoexporter.h

Go to the documentation of this file.

/***************************************************************************
                             qgsvideoexporter.h
                             --------------------------
    begin                : November 2025
    copyright            : (C) 2025 by Nyall Dawson
    email                : nyall dot dawson at gmail dot com
 ***************************************************************************
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 ***************************************************************************/
#ifndef QGSVIDEOEXPORTER_H
#define QGSVIDEOEXPORTER_H
 
#include "qgis_core.h"
#include "qgis_sip.h"
 
#include <QObject>
#include <QPointer>
#include <QSize>
#include <QtMultimedia/QMediaFormat>
#include <QtMultimedia/QMediaRecorder>
 
class QgsFeedback;
class QMediaCaptureSession;
class QVideoFrameInput;

class CORE_EXPORT QgsVideoExporter : public QObject
{
    Q_OBJECT
 
  public:
    static bool isAvailable();

    QgsVideoExporter( const QString &filename, QSize size, double framesPerSecond );
    ~QgsVideoExporter() override;

    void setFeedback( QgsFeedback *feedback );

    QgsFeedback *feedback();

    double framesPerSecond() const { return mFramesPerSecond; }

    qint64 frameDuration() const { return mFrameDurationUs; }

    QSize size() const { return mSize; }

    void setInputFiles( const QStringList &files );

    void setInputFilesByPattern( const QString &directory, const QString &pattern );

    QStringList inputFiles() const;
 
#ifndef SIP_RUN
    void setFileFormat( QMediaFormat::FileFormat format );

    QMediaFormat::FileFormat fileFormat() const;

    void setVideoCodec( QMediaFormat::VideoCodec codec );

    QMediaFormat::VideoCodec videoCodec() const;

    QMediaRecorder::Error error() const;
#endif
 
#ifdef SIP_PYQT6_RUN

    void setFileFormat( QMediaFormat::FileFormat format );

    QMediaFormat::FileFormat fileFormat() const;

    void setVideoCodec( QMediaFormat::VideoCodec codec );

    QMediaFormat::VideoCodec videoCodec() const;

    QMediaRecorder::Error error() const;
#endif

    QString errorString() const;
 
  public slots:

    void writeVideo() SIP_THROW( QgsNotSupportedException );
 
  signals:

    void finished();
 
  private slots:
 
    void feedFrames();
    void checkStatus( QMediaRecorder::RecorderState state );
    void handleError( QMediaRecorder::Error error, const QString &errorString );
 
  private:
    QString mFileName;
    QSize mSize;
    QStringList mInputFiles;
    double mFramesPerSecond = 10;
    qint64 mFrameDurationUs = 100000;
    QMediaFormat::FileFormat mFormat = QMediaFormat::FileFormat::MPEG4;
    QMediaFormat::VideoCodec mCodec = QMediaFormat::VideoCodec::H264;
    QMediaRecorder::Error mError = QMediaRecorder::Error::NoError;
    int mCurrentFrameIndex = 0;
    QPointer< QgsFeedback > mFeedback;
 
    QString mErrorString;
 
    std::unique_ptr< QMediaCaptureSession > mSession;
    std::unique_ptr< QMediaRecorder > mRecorder;
#if QT_VERSION >= QT_VERSION_CHECK( 6, 8, 0 )
    std::unique_ptr< QVideoFrameInput > mVideoInput;
#endif
};
 
 
#endif // QGSVIDEOEXPORTER_H