plugin.h

/* Copyright (c) 2009-2010, Cedric Stalder <cedric.stalder@gmail.com>
 *               2009-2013, Stefan Eilemann <eile@equalizergraphics.com>
 *
 * This file is part of Lunchbox <https://github.com/Eyescale/Lunchbox>
 *
 * This library is free software; you can redistribute it and/or modify it under
 * the terms of the GNU Lesser General Public License version 2.1 as published
 * by the Free Software Foundation.
 *
 * This library 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 Lesser General Public License for more
 * details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this library; if not, write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 */

#ifndef LUNCHBOX_PLUGIN_H
#define LUNCHBOX_PLUGIN_H

#include <lunchbox/types.h>
#include <lunchbox/dso.h>           // base class
#include <lunchbox/visitorResult.h> // enum
#include <lunchbox/plugins/compressor.h> // GLEW definition

namespace lunchbox
{
namespace detail { class Plugin; }

class Plugin : public DSO
{
public:
    LUNCHBOX_API explicit Plugin( const std::string& libraryName );

    LUNCHBOX_API virtual ~Plugin();

    typedef size_t ( *GetNumCompressors_t ) ();
    typedef void*  ( *NewCompressor_t ) ( const unsigned );
    typedef void   ( *DeleteCompressor_t ) ( void* const );
    typedef void*  ( *NewDecompressor_t ) ( const unsigned );
    typedef void   ( *DeleteDecompressor_t ) ( void* const );
    typedef void   ( *Compress_t ) ( void* const, const unsigned,
                                     void* const, const uint64_t*,
                                     const uint64_t );
    typedef unsigned ( *GetNumResults_t ) ( void* const, const unsigned );
    typedef void   ( *GetResult_t ) ( void* const, const unsigned,
                                      const unsigned, void** const,
                                      uint64_t* const );
    typedef void   ( *Decompress_t ) ( void* const, const unsigned,
                                       const void* const*,
                                       const uint64_t* const,
                                       const unsigned, void* const,
                                       uint64_t* const,
                                       const uint64_t );
    typedef bool ( *IsCompatible_t ) ( const unsigned, const GLEWContext* );
    typedef void ( *Download_t )( void* const, const unsigned,
                                  const GLEWContext*, const uint64_t*,
                                  const unsigned, const uint64_t,
                                  uint64_t*, void** );
    typedef void ( *StartDownload_t )( void* const, const unsigned,
                                       const GLEWContext*, const uint64_t*,
                                       const unsigned, const uint64_t );
    typedef void ( *FinishDownload_t )( void* const, const unsigned,
                                        const GLEWContext*, const uint64_t*,
                                        const uint64_t, uint64_t*, void** );
    typedef void ( *Upload_t )( void* const, const unsigned,
                                const GLEWContext*, const void*,
                                const uint64_t*,
                                const uint64_t, const uint64_t*,
                                const unsigned  );

    LUNCHBOX_API bool isGood() const;

    LUNCHBOX_API VisitorResult accept( PluginVisitor& visitor );

    LUNCHBOX_API VisitorResult accept( ConstPluginVisitor& visitor ) const;

    bool implementsType( const uint32_t name ) const;

    LUNCHBOX_API EqCompressorInfo findInfo( const uint32_t name ) const;

    LUNCHBOX_API const CompressorInfos& getInfos() const;

    GetNumCompressors_t const getNumCompressors;

    NewCompressor_t const newCompressor;

    NewDecompressor_t const newDecompressor;

    DeleteCompressor_t const deleteCompressor;

    DeleteDecompressor_t const deleteDecompressor;

    Compress_t const compress;

    Decompress_t const decompress;

    GetNumResults_t const getNumResults;

    GetResult_t const getResult;

    IsCompatible_t const isCompatible;

    Download_t const download;

    Upload_t const upload;

    StartDownload_t const startDownload;

    FinishDownload_t const finishDownload;

private:
    detail::Plugin* const impl_;
};
}
#endif //LUNCHBOX_PLUGIN_H