FFGLPluginSource.h

/*
 *   FFGLPluginSource
 *
 *   This file is part of GLMixer.
 *
 *   GLMixer 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 3 of the License, or
 *   (at your option) any later version.
 *
 *   GLMixer 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 GLMixer.  If not, see <http://www.gnu.org/licenses/>.
 *
 *   Copyright 2009, 2012 Bruno Herbelin
 *
 */

#ifndef FFGLPLUGINSOURCE_H
#define FFGLPLUGINSOURCE_H

#include <FFGL.h>

#include <QtCore>
#include <QString>
#include <QElapsedTimer>
#include <QDomElement>

class FFGLPluginException : public QtConcurrent::Exception {
public:
    virtual QString message() { return QObject::tr("FreeframeGL plugin crashed."); }
    void raise() const { throw *this; }
    Exception *clone() const { return new FFGLPluginException(*this); }
};



class FFGLPluginSource : public QObject
{
    Q_OBJECT

public:

    FFGLPluginSource(int w, int h, FFGLTextureStruct inputTexture);
    virtual ~FFGLPluginSource();

    // Run-Time Type Information
    typedef enum {
        FREEFRAME_PLUGIN = 0,
        SHADERTOY_PLUGIN
    } RTTI;
    virtual RTTI rtti() const { return type; }

    // loading of FFGL plugin
    void load(QString filename);

    // update & bind texture (to be called at each update of source)
    void update();
    void bind() const;

    // general attributes
    inline QString fileName() const { return _filename; }
    inline bool isSourceType() const { return _isFreeframeTypeSource; }
    inline int width() const { return _fboSize.width(); }
    inline int height() const { return _fboSize.height(); }

    // texture attributes
    FFGLTextureStruct getOutputTextureStruct();
    FFGLTextureStruct getInputTextureStruct();
    void setInputTextureStruct(FFGLTextureStruct inputTexture);

    // query state
    bool isPlaying() { return !_pause;}
    bool isinitialized() { return _initialized;}
    bool isEnabled() { return _enabled; }

    // plugin parameters
    QVariantHash getParameters();
    QVariantHash getParametersDefaults() { return _parametersDefaults; }
    void setParameter(int parameterNum, QVariant value);
    void setParameter(QString parameterName, QVariant value);

    // get plugin information
    inline QVariantHash getInfo() { return _info; }

    // XML config
    virtual QDomElement getConfiguration(QDir current = QDir());
    virtual void setConfiguration(QDomElement xml);

    static QString libraryFileName(QString embeddedName, bool install=true);


public slots:
    // enable updates
    void play(bool on);
    void enable(bool on);
    // reset
    void restoreDefaults();
    void resize(int w, int h);

signals:
    void initialized(FFGLPluginSource *);
    void updated();
    void changed();

protected:
    // FFGL specialized objects for plugin
    class FFGLPluginInstance *_plugin;

    // initialization should be called from inside
    bool initialize();

    // self management
    QVariantHash _parametersDefaults;
    QVariantHash _info;
    QString _filename;
    bool _initialized, _isFreeframeTypeSource;


private:
    //this represents the texture (on the GPU) that we feed to the plugins
    FFGLTextureStruct _inputTexture;

    // timer
    QElapsedTimer timer;
    qint64 _elapsedtime;
    bool _pause, _enabled;

    // Frame buffer objet
    class QGLFramebufferObject *_fbo;
    QSize _fboSize;

    // RTTI
    static RTTI type;
};




#endif // FFGLPLUGINSOURCE_H