frameData.h

/* Copyright (c) 2006-2014, Stefan Eilemann <eile@equalizergraphics.com>
 *                    2011, Daniel Nachbaur <danielnachbaur@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_FRAMEDATA_H
#define EQ_FRAMEDATA_H

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

#include <eq/fabric/pixelViewport.h> // member
#include <eq/fabric/pixel.h>         // member
#include <eq/fabric/range.h>         // member
#include <eq/fabric/subPixel.h>      // member

#include <co/object.h>               // base class
#include <lunchbox/monitor.h>         // member
#include <lunchbox/spinLock.h>        // member

namespace eq
{
namespace detail { class FrameData; }

class FrameData : public co::Object, public lunchbox::Referenced
{
public:
    void assembleFrame( Frame* frame, Channel* channel );
    struct ImageHeader
    {
        uint32_t                internalFormat;
        uint32_t                externalFormat;
        uint32_t                pixelSize;
        fabric::PixelViewport   pvp;
        uint32_t                compressorName;
        uint32_t                compressorFlags;
        uint32_t                nChunks;
        float                   quality;
    };

    EQ_API FrameData();

    EQ_API virtual ~FrameData();

    EQ_API Frame::Type getType() const;

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

    EQ_API uint32_t getBuffers() const;

    EQ_API void setBuffers( const uint32_t buffers );

    EQ_API const Range& getRange() const;

    EQ_API void setRange( const Range& range );

    EQ_API const Pixel& getPixel() const;

    EQ_API const SubPixel& getSubPixel() const;

    EQ_API uint32_t getPeriod() const;

    EQ_API uint32_t getPhase() const;

    EQ_API const Images& getImages() const;

    EQ_API void setPixelViewport( const PixelViewport& pvp );

    EQ_API const PixelViewport& getPixelViewport() const;

    EQ_API void setAlphaUsage( const bool useAlpha );

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

    EQ_API void setZoom( const Zoom& zoom );

    EQ_API const Zoom& getZoom() const;

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

    EQ_API Image* newImage( const Frame::Type type,
                            const DrawableConfig& config );

    EQ_API void clear();

    void flush();

    void deleteGLObjects( util::ObjectManager& om );

    EQ_API void resetPlugins();

#ifndef EQ_2_0_API

    void readback( const Frame& frame, util::ObjectManager& glObjects,
                   const DrawableConfig& config );
#endif

    Images startReadback( const Frame& frame,
                          util::ObjectManager& glObjects,
                          const DrawableConfig& config,
                          const PixelViewports& regions );

    void setReady();

    EQ_API bool isReady() const;

    EQ_API void waitReady( const uint32_t timeout = LB_TIMEOUT_INDEFINITE )
        const;

    void setVersion( const uint64_t version );

    typedef lunchbox::Monitor< uint32_t > Listener; 

    void addListener( Listener& listener );

    void removeListener( Listener& listener );

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

    struct Data
    {
        Data() : frameType( Frame::TYPE_MEMORY ), buffers( 0 ), period( 1 )
               , phase( 0 ) {}

        PixelViewport pvp;
        fabric::Frame::Type frameType;
        uint32_t      buffers;
        uint32_t      period;
        uint32_t      phase;
        Range         range;     //<! database-range of src wrt to dest
        Pixel         pixel;     //<! pixel decomposition of source
        SubPixel      subpixel;  //<! subpixel decomposition of source
        Zoom          zoom;

        EQ_API void serialize( co::DataOStream& os ) const;
        EQ_API void deserialize( co::DataIStream& is );
    };

    const Data& getData() const; 

    bool addImage( const co::ObjectVersion& frameDataVersion,
                   const PixelViewport& pvp, const Zoom& zoom,
                   const uint32_t buffers, const bool useAlpha,
                   uint8_t* data );
    void setReady( const co::ObjectVersion& frameData,
                   const FrameData::Data& data ); 

protected:
    virtual ChangeType getChangeType() const { return INSTANCE; }
    virtual void getInstanceData( co::DataOStream& os );
    virtual void applyInstanceData( co::DataIStream& is );

private:
    detail::FrameData* const _impl;

    Image* _allocImage( const Frame::Type type,
                        const DrawableConfig& config,
                        const bool setQuality );

    void _applyVersion( const uint128_t& version );

    void _setReady( const uint64_t version );

    LB_TS_VAR( _commandThread );
};

EQ_API std::ostream& operator << ( std::ostream&, const FrameData& );
}

namespace lunchbox
{
template<> inline void byteswap( eq::FrameData::Data& value )
{
    byteswap( value.pvp );
    byteswap( value.frameType );
    byteswap( value.buffers );
    byteswap( value.period );
    byteswap( value.phase );
    byteswap( value.range );
    byteswap( value.pixel );
    byteswap( value.subpixel );
    byteswap( value.zoom );
}
}

#endif // EQ_FRAMEDATA_H