server/window.h

/* Copyright (c) 2005-2009, Stefan Eilemann <eile@equalizergraphics.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 EQSERVER_WINDOW_H
#define EQSERVER_WINDOW_H

#ifdef EQUALIZERSERVERLIBRARY_EXPORTS
   // We need to instantiate a Monitor< State > when compiling the library,
   // but we don't want to have <pthread.h> for a normal build, hence this hack
#  include <pthread.h>
#endif
#include <eq/base/monitor.h>

#include "types.h"
#include "visitorResult.h"  // enum
#include "swapBarrier.h"
#include <eq/client/pixelViewport.h>
#include <eq/client/window.h>
#include <eq/net/barrier.h>
#include <eq/net/object.h>

#include <iostream>
#include <vector>

namespace eq
{
namespace server
{
    class WindowVisitor;
    class ConstWindowVisitor;
    struct ChannelPath;
    struct WindowPath;

    class Window : public net::Object
    {
    public:
        enum State
        {
            STATE_STOPPED = 0,  // next: INITIALIZING
            STATE_INITIALIZING, // next: INIT_FAILED or INIT_SUCCESS
            STATE_INIT_SUCCESS, // next: RUNNING
            STATE_INIT_FAILED,  // next: EXITING
            STATE_RUNNING,      // next: EXITING
            STATE_EXITING,      // next: EXIT_FAILED or EXIT_SUCCESS
            STATE_EXIT_SUCCESS, // next: STOPPED
            STATE_EXIT_FAILED,  // next: STOPPED
        };

        EQSERVER_EXPORT Window();

        Window( const Window& from, Pipe* pipe );

        EQSERVER_EXPORT void addChannel( Channel* channel );

        void insertChannel( const Channel* position, Channel* channel );

        bool removeChannel( Channel* channel );

        const ChannelVector& getChannels() const { return _channels; }

        Pipe*       getPipe()       { return _pipe; }
        const Pipe* getPipe() const { return _pipe; }

        Node* getNode();
        const Node* getNode() const;

        Config* getConfig();
        const Config* getConfig() const;
        
        WindowPath getPath() const;

        Channel* getChannel( const ChannelPath& path );

        const eq::Window::DrawableConfig& getDrawableConfig() const
            { return _drawableConfig; }

        net::CommandQueue* getServerThreadQueue();
        net::CommandQueue* getCommandThreadQueue();

        State getState() const { return _state.get(); }

        EQSERVER_EXPORT VisitorResult accept( WindowVisitor& visitor );
        EQSERVER_EXPORT VisitorResult accept( ConstWindowVisitor& ) const;

        void activate();

        void deactivate();

        bool isActive() const { return (_active != 0); }

        void addTasks( const uint32_t tasks );

        void setName( const std::string& name ) { _name = name; }
        const std::string& getName() const      { return _name; }

        EQSERVER_EXPORT void setPixelViewport( const eq::PixelViewport& pvp );

        const eq::PixelViewport& getPixelViewport() const { return _pvp; }

        void setViewport( const eq::Viewport& vp );

        const eq::Viewport& getViewport() const { return _vp; }

        void notifyViewportChanged();

        net::Barrier* joinSwapBarrier( net::Barrier* barrier );

        net::Barrier* joinNVSwapBarrier( const SwapBarrier* swapBarrier,
                                         net::Barrier* netBarrier );

        bool hasNVSwapBarrier() const { return (_nvSwapBarrier != 0); }

        void setLastDrawChannel( const Channel* channel )
            { _lastDrawChannel = channel; }
        const Channel* getLastDrawChannel() const { return _lastDrawChannel; }

        void setMaxFPS( const float fps ) { _maxFPS = fps; }
        float getMaxFPS() const { return _maxFPS; }

        void updateRunning( const uint32_t initID );

        bool syncRunning();

        void updateDraw( const uint32_t frameID, const uint32_t frameNumber );

        void updatePost( const uint32_t frameID, const uint32_t frameNumber );

        void setIAttribute( const eq::Window::IAttribute attr,
                            const int32_t value )
            { _iAttributes[attr] = value; }
        int32_t  getIAttribute( const eq::Window::IAttribute attr ) const
            { return _iAttributes[attr]; }

        const std::string& getErrorMessage() const { return _error; }

        void send( net::ObjectPacket& packet );

    protected:
        virtual ~Window();

        base::RequestHandler _requestHandler;

        virtual void attachToSession( const uint32_t id, 
                                      const uint32_t instanceID, 
                                      net::Session* session );
    private:
        eq::Window::DrawableConfig _drawableConfig;

        std::string _name;

        std::string            _error;

        int32_t _iAttributes[eq::Window::IATTR_ALL];

        ChannelVector _channels;

        uint32_t _active;

        Pipe* _pipe;
        friend class Pipe;

        uint32_t _tasks;

        base::Monitor< State > _state;
            
        eq::PixelViewport _pvp;
        
        eq::Viewport _vp;
        
        float _maxFPS;

        bool _swapFinish;

        bool _swap;

        bool _fixedPVP;

        net::BarrierVector _masterSwapBarriers;
        net::BarrierVector _swapBarriers;

        const SwapBarrier* _nvSwapBarrier;

        net::Barrier* _nvNetBarrier;

        const Channel* _lastDrawChannel;

        union // placeholder for binary-compatible changes
        {
            char dummy[64];
        };

        void _construct();

        void _resetSwapBarriers();

        void _send( net::ObjectPacket& packet, const std::string& string );

        void _configInit( const uint32_t initID );
        bool _syncConfigInit();
        void _configExit();
        bool _syncConfigExit();

        void _updateSwap( const uint32_t frameNumber );

        virtual void getInstanceData( net::DataOStream& os ) { EQDONTCALL }
        virtual void applyInstanceData( net::DataIStream& is ) { EQDONTCALL }

        /* command handler functions. */
        net::CommandResult _cmdConfigInitReply( net::Command& command ); 
        net::CommandResult _cmdConfigExitReply( net::Command& command ); 
        net::CommandResult _cmdSetPixelViewport( net::Command& command );

        // For access to _fixedPVP
        friend std::ostream& operator << ( std::ostream&, const Window*);
    };

    std::ostream& operator << ( std::ostream& os, const Window* window );
}
}

#endif // EQSERVER_WINDOW_H