OgreProfiler.h

Go to the documentation of this file.

/*
-----------------------------------------------------------------------------
This source file is part of OGRE
    (Object-oriented Graphics Rendering Engine)
For the latest info, see http://www.ogre3d.org/

Copyright (c) 2000-2013 Torus Knot Software Ltd

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
-----------------------------------------------------------------------------
*/
/*

    Although the code is original, many of the ideas for the profiler were borrowed from 
"Real-Time In-Game Profiling" by Steve Rabin which can be found in Game Programming
Gems 1.

    This code can easily be adapted to your own non-Ogre project. The only code that is 
Ogre-dependent is in the visualization/logging routines and the use of the Timer class.

    Enjoy!

*/

#ifndef __Profiler_H__
#define __Profiler_H__

#include "OgrePrerequisites.h"
#include "OgreSingleton.h"
#include "OgreString.h"
#include "OgreHeaderPrefix.h"

#if OGRE_PROFILING == 1
#   define OgreProfile( a ) Ogre::Profile _OgreProfileInstance( (a) )
#   define OgreProfileBegin( a ) Ogre::Profiler::getSingleton().beginProfile( (a) )
#   define OgreProfileEnd( a ) Ogre::Profiler::getSingleton().endProfile( (a) )
#   define OgreProfileGroup( a, g ) Ogre::Profile _OgreProfileInstance( (a), (g) )
#   define OgreProfileBeginGroup( a, g ) Ogre::Profiler::getSingleton().beginProfile( (a), (g) )
#   define OgreProfileEndGroup( a, g ) Ogre::Profiler::getSingleton().endProfile( (a), (g) )
#   define OgreProfileBeginGPUEvent( g ) Ogre::Profiler::getSingleton().beginGPUEvent(g)
#   define OgreProfileEndGPUEvent( g ) Ogre::Profiler::getSingleton().endGPUEvent(g)
#   define OgreProfileMarkGPUEvent( e ) Ogre::Profiler::getSingleton().markGPUEvent(e)
#else
#   define OgreProfile( a )
#   define OgreProfileBegin( a )
#   define OgreProfileEnd( a )
#   define OgreProfileGroup( a, g ) 
#   define OgreProfileBeginGroup( a, g ) 
#   define OgreProfileEndGroup( a, g ) 
#   define OgreProfileBeginGPUEvent( e )
#   define OgreProfileEndGPUEvent( e )
#   define OgreProfileMarkGPUEvent( e )
#endif

namespace Ogre {
    enum ProfileGroupMask
    {
        OGREPROF_USER_DEFAULT = 0x00000001,
        OGREPROF_ALL = 0xFF000000,
        OGREPROF_GENERAL = 0x80000000,
        OGREPROF_CULLING = 0x40000000,
        OGREPROF_RENDERING = 0x20000000
    };

    class _OgreExport Profile : 
        public ProfilerAlloc 
    {

        public:
            Profile(const String& profileName, uint32 groupID = (uint32)OGREPROF_USER_DEFAULT);
            ~Profile();

        protected:

            String mName;
            uint32 mGroupID;
            
    };

    struct ProfileFrame 
    {

        ulong   frameTime;

        uint    calls;

        uint    hierarchicalLvl;

    };

    struct ProfileHistory 
    {
        Real    currentTimePercent; 
        Real    currentTimeMillisecs;

        Real    maxTimePercent; 
        Real    maxTimeMillisecs; 

        Real    minTimePercent; 
        Real    minTimeMillisecs; 

        uint    numCallsThisFrame;

        Real    totalTimePercent;
        Real    totalTimeMillisecs;

        ulong   totalCalls; 

        uint    hierarchicalLvl;

    };

    class ProfileInstance : public ProfilerAlloc
    {
        friend class Profiler;
    public:
        ProfileInstance(void);
        virtual ~ProfileInstance(void);

        typedef Ogre::map<String,ProfileInstance*>::type ProfileChildren;

        void logResults();
        void reset();

        inline bool watchForMax(void) { return history.currentTimePercent == history.maxTimePercent; }
        inline bool watchForMin(void) { return history.currentTimePercent == history.minTimePercent; }
        inline bool watchForLimit(Real limit, bool greaterThan = true)
        {
            if (greaterThan)
                return history.currentTimePercent > limit;
            else
                return history.currentTimePercent < limit;
        }

        bool watchForMax(const String& profileName);
        bool watchForMin(const String& profileName);
        bool watchForLimit(const String& profileName, Real limit, bool greaterThan = true);
                                
        String          name;

        ProfileInstance* parent;

        ProfileChildren children;

        ProfileFrame frame;
        ulong frameNumber;

        ProfileHistory history;

        ulong           currTime;

        ulong           accum;

        uint            hierarchicalLvl;
    };

    class _OgreExport ProfileSessionListener
    {
    public:
        enum DisplayMode
        {
            DISPLAY_PERCENTAGE,
            DISPLAY_MILLISECONDS
        };

        ProfileSessionListener() : mDisplayMode(DISPLAY_MILLISECONDS) {}
        virtual ~ProfileSessionListener() {}

        virtual void initializeSession() = 0;

        virtual void finializeSession() = 0;

        virtual void changeEnableState(bool enabled) {}; 
        
        virtual void displayResults(const ProfileInstance& instance, ulong maxTotalFrameTime) {};

        void setDisplayMode(DisplayMode d) { mDisplayMode = d; }
    
        DisplayMode getDisplayMode() const { return mDisplayMode; }
    
    protected:
        DisplayMode mDisplayMode;
    };

    class _OgreExport Profiler : 
        public Singleton<Profiler>,
        public ProfilerAlloc
    {
        public:
            Profiler();
            ~Profiler();

            void setTimer(Timer* t);

            Timer* getTimer();

            void beginProfile(const String& profileName, uint32 groupID = (uint32)OGREPROF_USER_DEFAULT);

            void endProfile(const String& profileName, uint32 groupID = (uint32)OGREPROF_USER_DEFAULT);

            void beginGPUEvent(const String& event);

            void endGPUEvent(const String& event);

            void markGPUEvent(const String& event);

            void setEnabled(bool enabled);

            bool getEnabled() const;

            void enableProfile(const String& profileName);

            void disableProfile(const String& profileName);

            void setProfileGroupMask(uint32 mask) { mProfileMask = mask; }
            uint32 getProfileGroupMask() const { return mProfileMask; }

            bool watchForMax(const String& profileName);

            bool watchForMin(const String& profileName);

            bool watchForLimit(const String& profileName, Real limit, bool greaterThan = true);

            void logResults();

            void reset();

            void setUpdateDisplayFrequency(uint freq);

            uint getUpdateDisplayFrequency() const;

            void addListener(ProfileSessionListener* listener);

            void removeListener(ProfileSessionListener* listener);

            static Profiler& getSingleton(void);
            static Profiler* getSingletonPtr(void);

        protected:
            friend class ProfileInstance;

            typedef vector<ProfileSessionListener*>::type TProfileSessionListener;
            TProfileSessionListener mListeners;

            void initialize();

            void displayResults();

            void processFrameStats(void);
            void processFrameStats(ProfileInstance* instance, Real& maxFrameTime);

            void changeEnableState();

            // lol. Uses typedef; put's original container type in name.
            typedef set<String>::type DisabledProfileMap;
            typedef ProfileInstance::ProfileChildren ProfileChildren;

            ProfileInstance* mCurrent;
            ProfileInstance* mLast;
            ProfileInstance mRoot;

            DisabledProfileMap mDisabledProfiles;

            bool mInitialized;

            uint mUpdateDisplayFrequency;

            uint mCurrentFrame;

            Timer* mTimer;

            ulong mTotalFrameTime;

            bool mEnabled;

            bool mNewEnableState;

            uint32 mProfileMask;

            ulong mMaxTotalFrameTime;

            Real mAverageFrameTime;
            bool mResetExtents;


    }; // end class
} // end namespace

#include "OgreHeaderSuffix.h"

#endif