compressor.h

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

#include <lunchbox/api.h>
#include <lunchbox/types.h>
#include <lunchbox/thread.h>         // thread-safety macros

namespace lunchbox
{
namespace detail { class Compressor; }

class Compressor : public boost::noncopyable
{
    typedef detail::Compressor* const Compressor::*bool_t;

public:
    LUNCHBOX_API Compressor();

    LUNCHBOX_API Compressor( PluginRegistry& from, const uint32_t name );

    LUNCHBOX_API virtual ~Compressor();

    LUNCHBOX_API bool isGood() const;

    operator bool_t() const { return isGood() ? &Compressor::impl_ : 0; }

    bool operator ! () const { return !isGood(); }

    LUNCHBOX_API bool uses( const uint32_t name ) const;

    LUNCHBOX_API const EqCompressorInfo& getInfo() const;

    static LUNCHBOX_API uint32_t choose( const PluginRegistry& registry,
                                         const uint32_t tokenType,
                                         const float minQuality,
                                         const bool ignoreMSE );

    LUNCHBOX_API bool setup( PluginRegistry& from, const uint32_t name );

    LUNCHBOX_API bool setup( PluginRegistry& registry, const uint32_t tokenType,
                             const float minQuality, const bool ignoreMSE );

    LUNCHBOX_API bool realloc();

    LUNCHBOX_API void clear();

    LUNCHBOX_API void compress( void* const in, const uint64_t inDims[2] );

    LUNCHBOX_API void compress( void* const in, const uint64_t pvp[4],
                                const uint64_t flags );

    LUNCHBOX_API unsigned getNumResults() const LB_DEPRECATED;

    LUNCHBOX_API CompressorResult getResult() const;

    LUNCHBOX_API void getResult( const unsigned i, void** const out,
                                 uint64_t* const outSize ) const LB_DEPRECATED;

private:
    detail::Compressor* const impl_;
    LB_TS_VAR( _thread );
};
}
#endif  // LUNCHBOX_COMPRESSOR_H