framerateEqualizer.h

/* Copyright (c) 2008-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 EQS_FRAMERATEEQUALIZER_H
#define EQS_FRAMERATEEQUALIZER_H

#include "../channelListener.h" // base class
#include "equalizer.h"          // base class

#include <deque>
#include <map>

namespace eq
{
namespace server
{
    class FramerateEqualizer;
    std::ostream& operator << ( std::ostream& os, const FramerateEqualizer* );

    class FramerateEqualizer : public Equalizer
    {
    public:
        EQSERVER_EXPORT FramerateEqualizer();
        FramerateEqualizer( const FramerateEqualizer& from );
        virtual ~FramerateEqualizer();
        virtual Equalizer* clone() const
            { return new FramerateEqualizer( *this ); }
        virtual void toStream( std::ostream& os ) const { os << this; }

        virtual void attach( Compound* compound );

        virtual void notifyUpdatePre( Compound* compound, 
                                      const uint32_t frameNumber );

    protected:
        virtual void notifyChildAdded( Compound* compound, Compound* child )
            { EQASSERT( _nSamples == 0 ); }
        virtual void notifyChildRemove( Compound* compound, Compound* child )
            { EQASSERT( _nSamples == 0 ); }
        
    private:
        typedef std::pair< uint32_t, float > FrameTime;
        
        std::deque< FrameTime > _times;

        class LoadListener : public ChannelListener
        {
        public:
            virtual void notifyLoadData( Channel* channel, 
                                         const uint32_t frameNumber,
                                         const uint32_t nStatistics,
                                         const eq::Statistic* statistics  );

            FramerateEqualizer* parent;
            uint32_t period;
        };

        std::vector< LoadListener > _loadListeners;
        friend class LoadListener;

        uint32_t _nSamples;

        void _init();
        void _exit();
    };
}
}

#endif // EQS_LOADBALANCER_H