frameData.h

/* Copyright (c) 2006-2017, Stefan Eilemann <eile@equalizergraphics.com>
 *                          Daniel Nachbaur <danielnachbaur@gmail.com>
 *                          Enrique <egparedes@ifi.uzh.ch>
 *
 * 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 <co/object.h>           // base class
#include <eq/fabric/frameData.h> // base class
#include <eq/frame.h>            // enum Frame::Buffer
#include <eq/types.h>
#include <lunchbox/monitor.h>  // member
#include <lunchbox/spinLock.h> // member

namespace eq
{
namespace detail
{
class FrameData;
}

class FrameData : public fabric::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 const Images& getImages() const;

    EQ_API void setAlphaUsage(const bool useAlpha);

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

    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();

    EQ_API void flush();

    void deleteGLObjects(util::ObjectManager& om);

    EQ_API void resetPlugins();

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

    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);

    bool addImage(const co::ObjectVersion& frameDataVersion,
                  const PixelViewport& pvp, const Zoom& zoom,
                  const RenderContext& context, const Frame::Buffer buffers,
                  const bool useAlpha, uint8_t* data);
    void setReady(const co::ObjectVersion& frameData,
                  const fabric::FrameData& 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&);
}

#endif // EQ_FRAMEDATA_H