image.h

/* Copyright (c) 2006-2013, Stefan Eilemann <eile@equalizergraphics.com>
 *                    2011, Daniel Nachbaur <danielnachbaur@gmail.com>
 *                    2010, Cedric Stalder <cedric.stalder@gmail.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_IMAGE_H
#define EQ_IMAGE_H

#include <eq/client/frame.h>         // for Frame::Buffer enum
#include <eq/client/types.h>

namespace eq
{
namespace detail { class Image; }

    class Image
    {
    public:
        EQ_API Image();

        EQ_API virtual ~Image();

        EQ_API void setInternalFormat( const Frame::Buffer buffer,
                                       const uint32_t internalFormat );

        EQ_API uint32_t getInternalFormat( const Frame::Buffer buffer )const;

        EQ_API uint32_t getExternalFormat( const Frame::Buffer buffer ) const;

        EQ_API uint32_t getPixelSize( const Frame::Buffer buffer ) const;

        EQ_API bool hasAlpha() const;

        EQ_API void setStorageType( const Frame::Type type );

        EQ_API Frame::Type getStorageType() const;

        EQ_API void setPixelViewport( const PixelViewport& pvp );

        EQ_API const PixelViewport& getPixelViewport() const;

        EQ_API void setZoom( const Zoom& zoom );

        EQ_API const Zoom& getZoom() const;

        EQ_API void useCompressor( const Frame::Buffer buffer,
                                   const uint32_t name );

        EQ_API void reset();

        EQ_API void flush();

        EQ_API void deleteGLObjects( ObjectManager* om );

        EQ_API void resetPlugins();

        EQ_API const uint8_t* getPixelPointer( const Frame::Buffer buffer )
            const;

        EQ_API uint8_t* getPixelPointer( const Frame::Buffer buffer );

        EQ_API uint32_t getPixelDataSize( const Frame::Buffer buffer ) const;

        EQ_API const PixelData& getPixelData( const Frame::Buffer ) const;

        EQ_API const PixelData& compressPixelData( const Frame::Buffer );

        EQ_API bool hasPixelData( const Frame::Buffer buffer ) const;

        EQ_API bool hasAsyncReadback( const Frame::Buffer buffer ) const;

        EQ_API bool hasAsyncReadback() const;

        EQ_API void clearPixelData( const Frame::Buffer buffer );

        EQ_API void validatePixelData( const Frame::Buffer buffer );

        EQ_API void setPixelData( const Frame::Buffer buffer,
                                     const PixelData& data );

        EQ_API void setAlphaUsage( const bool enabled );

        EQ_API bool getAlphaUsage() const;

        EQ_API void setQuality( const Frame::Buffer buffer,
                                const float quality );

        EQ_API float getQuality( const Frame::Buffer buffer ) const;

        EQ_API const util::Texture& getTexture( const Frame::Buffer buffer )
            const;

        EQ_API bool hasTextureData( const Frame::Buffer buffer ) const;

#ifndef EQ_2_0_API

        EQ_API bool readback( const uint32_t buffers, const PixelViewport& pvp,
                              const Zoom& zoom, ObjectManager* glObjects );
#endif

        EQ_API bool startReadback( const uint32_t buffers,
                                   const PixelViewport& pvp, const Zoom& zoom,
                                   ObjectManager* glObjects );

        bool startReadback( const Frame::Buffer buffer,
                            const util::Texture* texture,
                            const GLEWContext* glewContext );

        EQ_API void finishReadback( const Zoom& zoom,
                                    const GLEWContext* glewContext );

        EQ_API bool upload( const Frame::Buffer buffer, util::Texture* texture,
                            const Vector2i& position,
                            ObjectManager* glObjects ) const;

        EQ_API bool writeImage( const std::string& filename,
                                   const Frame::Buffer buffer ) const;

        EQ_API bool writeImages( const std::string& filenameTemplate ) const;

        EQ_API bool readImage( const std::string& filename,
                               const Frame::Buffer buffer );

        void setOffset( int32_t x, int32_t y );

        EQ_API std::vector< uint32_t >
        findCompressors( const Frame::Buffer buffer ) const;

        EQ_API std::vector< uint32_t >
        findTransferers( const Frame::Buffer buffer, const GLEWContext* gl )
            const;

        EQ_API bool allocCompressor( const Frame::Buffer buffer,
                                     const uint32_t name );

        EQ_API bool allocDownloader( const Frame::Buffer buffer,
                                     const uint32_t name,
                                     const GLEWContext* glewContext );

        EQ_API uint32_t getDownloaderName( const Frame::Buffer buffer ) const;

    private:
        detail::Image* const _impl;

        const void* _getBufferKey( const Frame::Buffer buffer ) const;

        const void* _getCompressorKey( const Frame::Buffer buffer ) const;

        void _setExternalFormat( const Frame::Buffer buffer,
                                 const uint32_t externalFormat,
                                 const uint32_t pixelSize,
                                 const bool hasAlpha );

        bool _readback( const Frame::Buffer buffer, const Zoom& zoom,
                        ObjectManager* glObjects );

        bool _startReadback( const Frame::Buffer buffer, const Zoom& zoom,
                             ObjectManager* glObjects );

        void _finishReadback( const Frame::Buffer buffer, const Zoom& zoom,
                              const GLEWContext* glewContext );

        bool _readbackZoom( const Frame::Buffer buffer, const Zoom& zoom,
                            ObjectManager* glObjects );
    };
};
#endif // EQ_IMAGE_H