compressor.h

Go to the documentation of this file.

/* Copyright (c) 2009-2010, Cedric Stalder <cedric.stalder@gmail.com>
 *               2009-2013, Stefan Eilemann <eile@equalizergraphics.com>
 *
 * 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 EQ_PLUGIN_COMPRESSOR
#define EQ_PLUGIN_COMPRESSOR

#include <pression/plugins/compressor.h>
#include <lunchbox/buffer.h>
#include <vector>

namespace eq
{
namespace plugin
{
    class Compressor
    {
    public:
        typedef void  (*CompressorGetInfo_t)( EqCompressorInfo* const );
        typedef void* (*NewCompressor_t)( const unsigned );
        typedef void (*Decompress_t)( const void* const*, const
                                      eq_uint64_t* const,
                                      const unsigned, void* const,
                                      const eq_uint64_t, const bool );
        typedef bool ( *IsCompatible_t ) ( const GLEWContext* );

        struct Functions
        {
            Functions( const unsigned name, CompressorGetInfo_t getInfo,
                       NewCompressor_t newCompressor,
                       NewCompressor_t newDecompressor,
                       Decompress_t decompress, IsCompatible_t isCompatible );

            unsigned             name;
            CompressorGetInfo_t  getInfo;
            NewCompressor_t      newCompressor;
            NewCompressor_t      newDecompressor;
            Decompress_t         decompress;
            IsCompatible_t       isCompatible;
        };

        Compressor();
        virtual ~Compressor();

        virtual void compress( const void* const inData LB_UNUSED,
                               const eq_uint64_t nPixels LB_UNUSED,
                               const bool useAlpha LB_UNUSED ) { LBDONTCALL; }

        typedef lunchbox::Bufferb Result;
        typedef std::vector< Result* > Results;

        const Results& getResults() const { return _results; }

        unsigned getNResults() const { return _nResults; }

        virtual void download( const GLEWContext* glewContext LB_UNUSED,
                               const eq_uint64_t  inDims[4] LB_UNUSED,
                               const unsigned     source LB_UNUSED,
                               const eq_uint64_t  flags LB_UNUSED,
                               eq_uint64_t        outDims[4] LB_UNUSED,
                               void** out LB_UNUSED ) { LBDONTCALL; }

        virtual void upload( const GLEWContext* glewContext LB_UNUSED,
                             const void*        buffer LB_UNUSED,
                             const eq_uint64_t  inDims[4] LB_UNUSED,
                             const eq_uint64_t  flags LB_UNUSED,
                             const eq_uint64_t  outDims[4] LB_UNUSED,
                             const unsigned     destination LB_UNUSED )
            { LBDONTCALL; }

        virtual void startDownload( const GLEWContext* glewContext LB_UNUSED,
                                    const eq_uint64_t  inDims[4] LB_UNUSED,
                                    const unsigned     source LB_UNUSED,
                                    const eq_uint64_t  flags LB_UNUSED )
            { LBDONTCALL; }

        virtual void finishDownload( const GLEWContext* glewContext LB_UNUSED,
                                     const eq_uint64_t  inDims[4] LB_UNUSED,
                                     const eq_uint64_t  flags LB_UNUSED,
                                     eq_uint64_t        outDims[4] LB_UNUSED,
                                     void** out LB_UNUSED ) { LBDONTCALL; }

        static void registerEngine( const Functions& );

    protected:
        Results _results;   
        unsigned _nResults; 
    };
}
}

#endif // EQ_PLUGIN_COMPRESSOR