downloader.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_DOWNLOADER_H
#define LUNCHBOX_DOWNLOADER_H

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

namespace lunchbox
{
namespace detail { class Downloader; }

class Downloader : public boost::noncopyable
{
public:
    LUNCHBOX_API Downloader();

    LUNCHBOX_API Downloader( PluginRegistry& from, const uint32_t name,
                             const GLEWContext* gl = 0 );

    LUNCHBOX_API virtual ~Downloader();

    LUNCHBOX_API bool isGood() const;

    LUNCHBOX_API bool uses( const uint32_t name ) const;

    LUNCHBOX_API bool supports( const uint32_t inputToken, const bool noAlpha,
                                const uint64_t capabilities ) const;

    static LUNCHBOX_API uint32_t choose( const PluginRegistry& from,
                                         const uint32_t internalFormat,
                                         const float minQuality,
                                         const bool ignoreAlpha,
                                         const uint64_t capabilities,
                                         const GLEWContext* gl );

    LUNCHBOX_API const EqCompressorInfo& getInfo() const;

    LUNCHBOX_API bool setup( PluginRegistry& from, const uint32_t name,
                             const GLEWContext* gl = 0 );

    LUNCHBOX_API bool setup( PluginRegistry& from,const uint32_t internalFormat,
                             const float minQuality, const bool ignoreAlpha,
                             const uint64_t capabilities,
                             const GLEWContext* gl );

    LUNCHBOX_API void clear();

    LUNCHBOX_API bool start( void** buffer, const uint64_t inDims[4],
                             const uint64_t flags, uint64_t outDims[4],
                             const unsigned source, const GLEWContext* gl );

    LUNCHBOX_API void finish( void** buffer, const uint64_t inDims[4],
                              const uint64_t flags, uint64_t outDims[4],
                              const GLEWContext* gl );

private:
    detail::Downloader* const impl_;
    LB_TS_VAR( _thread );
};
}
#endif  // LUNCHBOX_DOWNLOADER_H