plugins/compressor.h

Go to the documentation of this file.

/* Copyright (c) 2009, Cedric Stalder <cedric.stalder@gmail.com> 
 *               2009, 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_PLUGINS_COMPRESSOR
#define EQ_PLUGINS_COMPRESSOR

#include <sys/types.h>

typedef unsigned long long eq_uint64_t;

#ifdef WIN32
#  ifdef EQ_PLUGIN_BUILD
#    define EQ_PLUGIN_API __declspec(dllexport) 
#  else
#    define EQ_PLUGIN_API __declspec(dllimport)
#  endif
#else // WIN32
#  define EQ_PLUGIN_API
#endif

#ifdef __cplusplus
extern "C"
{
#endif
 
    #define EQ_COMPRESSOR_VERSION 1

    #define EQ_COMPRESSOR_VERSION_1 1

    #define EQ_COMPRESSOR_NONE             0x1u

    #define EQ_COMPRESSOR_RLE_UNSIGNED     0x2u

    #define EQ_COMPRESSOR_RLE_BYTE         0x3u

    #define EQ_COMPRESSOR_RLE_3_BYTE       0x4u

    #define EQ_COMPRESSOR_RLE_4_BYTE       0x5u

    #define EQ_COMPRESSOR_RLE_4_FLOAT      0x6u

    #define EQ_COMPRESSOR_RLE_4_HALF_FLOAT 0x7u

    #define EQ_COMPRESSOR_DIFF_RLE_3_BYTE  0x8u

    #define EQ_COMPRESSOR_DIFF_RLE_4_BYTE  0x9u

    #define EQ_COMPRESSOR_RLE_4_BYTE_UNSIGNED  0xau

    #define EQ_COMPRESSOR_PRIVATE         0xefffffffu

    #define EQ_COMPRESSOR_DATATYPE_BYTE       1

    #define EQ_COMPRESSOR_DATATYPE_UNSIGNED   2

    #define EQ_COMPRESSOR_DATATYPE_HALF_FLOAT 3

    #define EQ_COMPRESSOR_DATATYPE_FLOAT      4


    #define EQ_COMPRESSOR_DATATYPE_3_BYTE       1024

    #define EQ_COMPRESSOR_DATATYPE_4_BYTE       1025

    #define EQ_COMPRESSOR_DATATYPE_3_HALF_FLOAT 1026

    #define EQ_COMPRESSOR_DATATYPE_4_HALF_FLOAT 1027

    #define EQ_COMPRESSOR_DATATYPE_3_FLOAT      1028

    #define EQ_COMPRESSOR_DATATYPE_4_FLOAT      1029

    #define EQ_COMPRESSOR_DATATYPE_3BYTE_1BYTE  2048

    #define EQ_COMPRESSOR_INPLACE    1

    #define EQ_COMPRESSOR_DATA_1D    2

    #define EQ_COMPRESSOR_DATA_2D    4

    #define EQ_COMPRESSOR_IGNORE_MSE 8

    struct EqCompressorInfo
    {
        unsigned version;

        unsigned name;
        unsigned tokenType;
        eq_uint64_t capabilities;
        float quality;
        float ratio;
        float speed;
    };
    
    EQ_PLUGIN_API size_t EqCompressorGetNumCompressors();
    EQ_PLUGIN_API void EqCompressorGetInfo( const size_t n,
                                            EqCompressorInfo* const info );
    EQ_PLUGIN_API void* EqCompressorNewCompressor( const unsigned name );
    EQ_PLUGIN_API void EqCompressorDeleteCompressor( void* const compressor );

    EQ_PLUGIN_API void* EqCompressorNewDecompressor( const unsigned name );
    EQ_PLUGIN_API void EqCompressorDeleteDecompressor(void* const decompressor);
    EQ_PLUGIN_API void EqCompressorCompress( void* const compressor, 
                                             const unsigned name,
                                             void* const in, 
                                             const eq_uint64_t* inDims,
                                             const eq_uint64_t flags );

    EQ_PLUGIN_API unsigned EqCompressorGetNumResults( void* const compressor,
                                                      const unsigned name );

    EQ_PLUGIN_API void EqCompressorGetResult( void* const compressor, 
                                              const unsigned name,
                                              const unsigned i, 
                                              void** const out, 
                                              eq_uint64_t* const outSize );

    EQ_PLUGIN_API void EqCompressorDecompress( void* const decompressor, 
                                               const unsigned name,
                                               const void* const* in, 
                                               const eq_uint64_t* const inSizes,
                                               const unsigned numInputs,
                                               void* const out,
                                               eq_uint64_t* const outDims,
                                               const eq_uint64_t flags );
#ifdef __cplusplus
}
#endif
#endif // EQ_PLUGINS_COMPRESSOR