pression::Decompressor Class Reference

A C++ class to handle one decompressor plugin instance. More...

#include <decompressor.h>

Collaboration diagram for pression::Decompressor:

Public Member Functions
	Decompressor ()
	Construct a new, invalid decompressor instance. More...
	Decompressor (PluginRegistry &from, const uint32_t name)
	Construct a new decompressor instance. More...
virtual	~Decompressor ()
	Destruct this decompressor. More...
bool	isGood () const
	operator bool_t () const
bool	operator! () const
bool	uses (const uint32_t name) const
const EqCompressorInfo &	getInfo () const
bool	setup (PluginRegistry &from, const uint32_t name)
	Set up a new, named decompressor instance. More...
void	clear ()
	Reset to EQ_COMPRESSOR_NONE. More...
void	decompress (const void *const *in, const uint64_t *const inSizes, const unsigned numInputs, void *const out, uint64_t outDim[2])
	Decompress one-dimensional data. More...
bool	decompress (const CompressorResult &input, void *const out, uint64_t pvpOut[4], const uint64_t flags)
	Decompress two-dimensional data. More...
void	decompress (const void *const *in, const uint64_t *const inSizes, const unsigned numInputs, void *const out, uint64_t pvpOut[4], const uint64_t flags) LB_DEPRECATED

Detailed Description

A C++ class to handle one decompressor plugin instance.

Example:

/* Copyright (c) 2010-2016, Cedric Stalder <cedric.stalder@gmail.com>
 *                          Stefan Eilemann <eile@eyescale.ch>
 *
 * 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.
 */

#define TEST_RUNTIME 600 // seconds
#include <lunchbox/test.h>

#include <pression/compressor.h>
#include <pression/compressorInfo.h>
#include <pression/compressorResult.h>
#include <pression/decompressor.h>
#include <pression/plugin.h>
#include <pression/pluginRegistry.h>

#include <lunchbox/buffer.h>
#include <lunchbox/clock.h>
#include <lunchbox/file.h>
#include <lunchbox/memoryMap.h>
#include <lunchbox/rng.h>

#include <algorithm>

using namespace pression;

void _testFile();
void _testRandom();
void _testData( const uint32_t nameCompressor, const std::string& name,
                const uint8_t* data, const uint64_t size );

Strings getFiles( Strings& files, const std::string& ext );

PluginRegistry registry;
uint64_t _result = 0;
uint64_t _size = 0;
float _compressionTime = 0;
float _decompressionTime = 0;
float _baseTime = 0.f;

int main( int, char** )
{
    registry.addDirectory( std::string( PRESSION_BUILD_DIR ) + "/lib" );
    registry.addDirectory( "../bin" );
    registry.addDirectory( "../lib" );
    registry.addDirectory( "../../install/bin" );
    registry.addDirectory( "../../install/lib" );
    registry.addDirectory( "images" );
    registry.addDirectory(
        "/nfs4/bbp.epfl.ch/visualization/resources/meshes/mediumPly/" );
    registry.addDirectory(
        "/nfs4/bbp.epfl.ch/visualization/circuits/KaustCircuit/meshes" );
    registry.addDirectory(
        "/nfs4/bbp.epfl.ch/visualization/circuits/KaustCircuit/simulations/run_1k/20.02.13/" );
    TEST( registry.addLunchboxPlugins( ));
    registry.init();

    _testFile();
    _testRandom();
    registry.exit();

    Compressor compressor;
    TEST( !compressor.isGood( ));
    TEST( !compressor );

    Decompressor decompressor;
    TEST( !decompressor.isGood( ));
    TEST( !decompressor );
    return EXIT_SUCCESS;
}

std::vector< uint32_t > getCompressorNames( const uint32_t tokenType )
{
    const Plugins& plugins = registry.getPlugins();
    std::vector< uint32_t > names;

    for( PluginsCIter i = plugins.begin(); i != plugins.end(); ++i )
    {
        const CompressorInfos& infos = (*i)->getInfos();
        for( CompressorInfosCIter j = infos.begin(); j != infos.end(); ++j )
        {
            if ( (*j).tokenType == tokenType )
                names.push_back( (*j).name );
        }
    }

    std::sort( names.begin(), names.end( ));
    return names;
}

void _testData( const uint32_t compressorName, const std::string& name,
                const uint8_t* data, const uint64_t size )
{
    Compressor compressor( registry, compressorName );
    Decompressor decompressor( registry, compressorName );
    TEST( compressor.isGood( ));
    TEST( compressor );
    TESTINFO( decompressor.isGood(), compressorName );
    TESTINFO( decompressor, compressorName );

    const uint64_t flags = EQ_COMPRESSOR_DATA_1D;
    uint64_t inDims[2]  = { 0, size };

    compressor.compress( const_cast<uint8_t*>(data), inDims, flags );
    lunchbox::Clock clock;
    compressor.compress( const_cast<uint8_t*>(data), inDims, flags );
    const float compressTime = clock.getTimef();

    const CompressorResult& compressed = compressor.getResult();
    const uint64_t compressedSize = compressed.getSize();
    std::vector< void * > chunks;
    std::vector< uint64_t > chunkSizes;
    chunks.resize( compressed.chunks.size( ));
    chunkSizes.resize( chunks.size( ));

    for( unsigned i = 0; i < chunks.size(); ++i )
    {
        chunks[ i ] = compressed.chunks[i].data;
        chunkSizes[ i ] =  compressed.chunks[i].getNumBytes();
    }

    lunchbox::Bufferb result;
    result.resize( size );
    uint8_t* outData = result.getData();

    decompressor.decompress( &chunks.front(), &chunkSizes.front(),
                             unsigned( chunks.size( )), outData, inDims );

    clock.reset();
    decompressor.decompress( &chunks.front(), &chunkSizes.front(),
                             unsigned(chunks.size()), outData, inDims);
    const float decompressTime = clock.getTimef();

    TEST( memcmp( outData, data, size ) == 0 );
    std::cout  << std::setw(20) << name << ", 0x" << std::setw(8)
               << std::setfill( '0' ) << std::hex << compressorName << std::dec
               << std::setfill(' ') << ", " << std::setw(10) << size << ", "
               << std::setw(10) << compressedSize << ", " << std::setw(10)
               << float(size) / 1024.f / 1024.f * 1000.f / compressTime
               << ", " << std::setw(10)
               << float(size) / 1024.f / 1024.f * 1000.f / decompressTime
               << std::endl;
    _size += size;
    _result += compressedSize;
    _compressionTime += compressTime;
    _decompressionTime += decompressTime;
}

void _testFile()
{
    std::vector< uint32_t > compressorNames =
        getCompressorNames( EQ_COMPRESSOR_DATATYPE_BYTE );

    std::vector< std::string > files;

    getFiles( files, ".*\\.dll" );
    getFiles( files, ".*\\.exe" );
    getFiles( files, ".*\\.so" );
    getFiles( files, ".*\\.a" );
    getFiles( files, ".*\\.dylib" );
    getFiles( files, ".*\\.rgb" );
    getFiles( files, ".*\\.bin" );
    getFiles( files, ".*\\.ply" );
    getFiles( files, ".*\\.bbp" );

#if 1
    // Limit to 30 files using a pseudo-random selection for reproducability
    const size_t maxFiles = 30;
    if( files.size() > maxFiles )
    {
        const size_t cut = files.size() - maxFiles;
        for( size_t i = 0; i < cut; ++i )
            files.erase( files.begin() + (i * 997 /*prime*/) % files.size( ));
    }
#endif

    std::cout.setf( std::ios::right, std::ios::adjustfield );
    std::cout.precision( 5 );
    std::cout << "                File, Compressor, Uncompress, "
              << "Compressed,   comp MB/s, decomp MB/s" << std::endl;
    for( std::vector< uint32_t >::const_iterator i = compressorNames.begin();
         i != compressorNames.end(); ++i )
    {
        _result = 0;
        _size = 0;
        _compressionTime = 0;
        _decompressionTime = 0;

        for( StringsCIter j = files.begin(); j != files.end(); ++j )
        {
            lunchbox::MemoryMap file;
            const uint8_t* data = static_cast<const uint8_t*>( file.map( *j ));

            if( !data )
            {
                LBERROR << "Can't mmap " << *j << std::endl;
                continue;
            }

            const size_t size = file.getSize();
            if( size > LB_1GB )
                continue;

            const std::string name = lunchbox::getFilename( *j );

            _testData( *i, name, data, size );
        }
        if( _baseTime == 0.f )
            _baseTime = _compressionTime + _decompressionTime;

        std::cout << std::setw(24) << "Total, 0x" << std::setw(8)
                  << std::setfill( '0' ) << std::hex << *i << std::dec
                  << std::setfill(' ') << ", " << std::setw(10) << _size << ", "
                  << std::setw(10) << _result << ", " << std::setw(10)
                  << float(_size) / 1024.f / 1024.f * 1000.f / _compressionTime
                  << ", " << std::setw(10)
                  << float(_size) / 1024.f / 1024.f * 1000.f /_decompressionTime
                  << std::endl
                  << "    info->ratio = " << float(_result) / float(_size)
                  << "f;" << std::endl
                  << "    info->speed = " << float(_baseTime) /
                                    float(_compressionTime + _decompressionTime)
                  << "f;" << std::endl << std::endl;
    }
}

void _testRandom()
{
    ssize_t size = LB_10MB;
    uint8_t* data = new uint8_t[size];
    lunchbox::RNG rng;
#pragma omp parallel for
    for( ssize_t i = 0; i < size; ++i )
        data[i] = rng.get< uint8_t >();

    std::vector< uint32_t >compressorNames =
        getCompressorNames( EQ_COMPRESSOR_DATATYPE_BYTE );
    _result = 0;
    _size = 0;
    _compressionTime = 0;
    _decompressionTime = 0;

    for( std::vector<uint32_t>::const_iterator i = compressorNames.begin();
         i != compressorNames.end(); ++i )
    {
        size = LB_10MB;
        for( size_t j = 0; j<8; ++j ) // test all granularities between mod 8..1
        {
            _testData( *i, "Random data", data, size );
            --size;
        }
        std::cout << std::setw(24) << "Total, 0x" << std::setw(8)
                  << std::setfill( '0' ) << std::hex << *i << std::dec
                  << std::setfill(' ') << ", " << std::setw(10) << _size << ", "
                  << std::setw(10) << _result << ", " << std::setw(10)
                  << float(_size) / 1024.f / 1024.f * 1000.f / _compressionTime
                  << ", " << std::setw(10)
                  << float(_size) / 1024.f / 1024.f * 1000.f /_decompressionTime
                  << std::endl;
   }

    delete [] data;
}

Strings getFiles( Strings& files, const std::string& ext )
{
    Strings paths = registry.getDirectories();
    for( uint64_t j = 0; j < paths.size(); ++j )
    {
        const Strings& candidates = lunchbox::searchDirectory( paths[j], ext );
        for( StringsCIter i = candidates.begin(); i != candidates.end(); ++i )
        {
            const std::string& filename = *i;
            files.push_back( paths[j] + '/' + filename );
        }
    }
    return files;
}

Definition at line 36 of file decompressor.h.

Constructor & Destructor Documentation

pression::Decompressor::Decompressor

(

)

Construct a new, invalid decompressor instance.

Version

1.7.1

pression::Decompressor::Decompressor	(	PluginRegistry &	from,
		const uint32_t	name
	)

Construct a new decompressor instance.

Parameters

from	the plugin registry.
name	the name of the decompressor.

Version

1.7.1

virtual pression::Decompressor::~Decompressor ( )

virtual

Destruct this decompressor.

Version

1.7.1

Member Function Documentation

void pression::Decompressor::clear

(

)

Reset to EQ_COMPRESSOR_NONE.

Version

1.7.1

void pression::Decompressor::decompress	(	const void *const *	in,
		const uint64_t *const	inSizes,
		const unsigned	numInputs,
		void *const	out,
		uint64_t	outDim[2]
	)

Decompress one-dimensional data.

Parameters

in	the pointer to an array of input data pointers
inSizes	the array of input data sizes in bytes
numInputs	the number of input data elements
out	the pointer to a pre-allocated buffer for the uncompressed output result.
outDim	the dimensions of the output data.

Version

1.7.1

bool pression::Decompressor::decompress	(	const CompressorResult &	input,
		void *const	out,
		uint64_t	pvpOut[4],
		const uint64_t	flags
	)

Decompress two-dimensional data.

The output is not modified on error.

Parameters

input	the compressed data
out	the pointer to a pre-allocated buffer for the uncompressed output result.
pvpOut	the dimensions of the output data.
flags	capability flags for the decompression.

Returns

true on success, false otherwise

Version

1.9.1

const EqCompressorInfo& pression::Decompressor::getInfo

(

)

const

Returns

the information about the allocated instance.

Version

1.7.1

bool pression::Decompressor::isGood

(

)

const

Returns

true if the instance is usable.

Version

1.7.1

pression::Decompressor::operator bool_t ( ) const

inline

Returns

true if the instance is usable, false otherwise.

Version

1.9.1

Definition at line 63 of file decompressor.h.

bool pression::Decompressor::operator! ( ) const

inline

Returns

true if the instance is not usable.

Version

1.9.1

Definition at line 66 of file decompressor.h.

bool pression::Decompressor::setup	(	PluginRegistry &	from,
		const uint32_t	name
	)

Set up a new, named decompressor instance.

Parameters

from	the plugin registry.
name	the name of the decompressor.

Returns

true on success, false otherwise.

Version

1.7.1

bool pression::Decompressor::uses

(

const uint32_t

name

)

const

Returns

true if the instance is usable for the given name.

Version

1.7.1

---

The documentation for this class was generated from the following file:

• decompressor.h