decompressor.h

/* Copyright (c) 2013-2014, Stefan.Eilemann@epfl.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_DECOMPRESSOR_H
#define LUNCHBOX_DECOMPRESSOR_H

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

namespace lunchbox
{
namespace detail { class Decompressor; }

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

public:
    LUNCHBOX_API Decompressor();

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

    LUNCHBOX_API virtual ~Decompressor();

    LUNCHBOX_API bool isGood() const;

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

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

    LUNCHBOX_API bool uses( const uint32_t name ) const;

    LUNCHBOX_API const EqCompressorInfo& getInfo() const;

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

    LUNCHBOX_API void clear();

    LUNCHBOX_API void decompress( const void* const* in,
                                  const uint64_t* const inSizes,
                                  const unsigned numInputs, void* const out,
                                  uint64_t outDim[2] );
    LUNCHBOX_API bool decompress( const CompressorResult& input,
                                  void* const out, uint64_t pvpOut[4],
                                  const uint64_t flags );
    LUNCHBOX_API 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;

private:
    detail::Decompressor* const impl_;
    LB_TS_VAR( _thread );
};
}
#endif  // LUNCHBOX_DECOMPRESSOR_H