StelVideoMgr.hpp

/*
 * Copyright (C) 2012 Sibi Antony (Phonon/QT4 implementation)
 * Copyright (C) 2015 Georg Zotti (Reactivated with QT5 classes)
 *
 * 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.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Suite 500, Boston, MA  02110-1335, USA.
 */

#ifndef _STELVIDEOMGR_HPP_
#define _STELVIDEOMGR_HPP_

#include <QObject>
#include <QMap>
#include <QString>
#ifdef ENABLE_MEDIA
#include <QSize>
#include <QSizeF>
#include <QPoint>
#include <QPointF>
#include <QMediaContent>
#include <QMediaPlayer>
#include "StelFader.hpp"
#endif
#include "StelModule.hpp"

class QGraphicsVideoItem;


class StelVideoMgr : public StelModule
{
    Q_OBJECT

public:
    StelVideoMgr();
    ~StelVideoMgr();

public slots:

    // Methods from StelModule: only update() needed.
    virtual void init(){;} // Or do something?

    virtual void update(double deltaTime);

    void loadVideo(const QString& filename, const QString& id, const float x, const float y, const bool show, const float alpha);
    void playVideo(const QString& id, const bool keepVisibleAtEnd=false);

    void playVideoPopout(const QString& id, float fromX, float fromY, float atCenterX, float atCenterY, float finalSizeX, float finalSizeY, float popupDuration, bool frozenInTransition);

    void pauseVideo(const QString& id);

    void stopVideo(const QString& id);

    void dropVideo(const QString& id);

    void seekVideo(const QString& id, const qint64 ms, bool pause=false);

    void setVideoXY(const QString& id, const float x, const float y, const bool relative=false);

    void setVideoAlpha(const QString& id, const float alpha);

    void resizeVideo(const QString& id, float w = -1.0f, float h = -1.0f);

    void showVideo(const QString& id, const bool show);

    qint64 getVideoDuration(const QString& id);

    qint64 getVideoPosition(const QString& id);

    QSize getVideoResolution(const QString& id);
    int getVideoWidth(const QString& id);
    int getVideoHeight(const QString& id);

    void muteVideo(const QString& id, bool muteVideo=true);
    void setVideoVolume(const QString& id, int newVolume);
    int getVideoVolume(const QString& id);

    bool isVideoPlaying(const QString& id);

#ifdef ENABLE_MEDIA
private slots:
    // Slots to handle QMediaPlayer signals. Never call them yourself!
    // Some of them are useful to understand media handling and to get to crucial information like native resolution and duration during loading of media.
    // Most only give simple debug output...
    void handleAudioAvailableChanged(bool available);
    void handleBufferStatusChanged(int percentFilled);
    void handleDurationChanged(qint64 duration);
    void handleError(QMediaPlayer::Error error);
    void handleMediaStatusChanged(QMediaPlayer::MediaStatus status);
    void handleMutedChanged(bool muted);
    //void handlePositionChanged(qint64 position); // periodically notify where in the video we are. Could be used to update scale bars, not needed.
    void handleSeekableChanged(bool seekable);
    void handleStateChanged(QMediaPlayer::State state);
    void handleVideoAvailableChanged(bool videoAvailable);
    void handleVolumeChanged(int volume);

    // Slots to handle QMediaPlayer change signals inherited from QMediaObject:
    void handleAvailabilityChanged(bool available);
    void handleAvailabilityChanged(QMultimedia::AvailabilityStatus availability);
    void handleMetaDataChanged();
    // This signal is not triggered on Windows, we must work around using handleMetaDataChanged()
    //void handleMetaDataChanged(const QString & key, const QVariant & value);
#endif


private:
#if 0
    // Traces of old Qt4/Phonon:
    typedef struct {
        QWidget *widget;
        Phonon::VideoPlayer *player;
        QGraphicsProxyWidget *pWidget;
    } VideoPlayer;
    QMap<QString, VideoPlayer*> videoObjects; 
#endif
#ifdef ENABLE_MEDIA
    typedef struct {
        //QVideoWidget *widget; // would be easiest, but only with QtQuick2...
        QGraphicsVideoItem *videoItem;
        QMediaPlayer *player;
        qint64 duration;           
        QSize resolution;          
        bool keepVisible;          
        bool needResize;           
        bool simplePlay;           
        LinearFader fader;         
        QSizeF  targetFrameSize;   
        QPointF popupOrigin;       
        QPointF popupTargetCenter; 
        int lastPos;               
    } VideoPlayer;
    QMap<QString, VideoPlayer*> videoObjects;
    bool verbose;                      
#endif
};

#endif // _STELVIDEOMGR_HPP_