Changeset 10098

Timestamp:

04/24/09 18:20:50 (4 years ago)

Author:

robert

Message:

Introduce new run frame rate management support to allow control of maximum frame rate and to support on demand rendering of frames

Location:

OpenSceneGraph/trunk

Files:

• include/osgViewer/CompositeViewer (modified) (3 diffs)
• include/osgViewer/View (modified) (1 diff)
• include/osgViewer/Viewer (modified) (4 diffs)
• include/osgViewer/ViewerBase (modified) (5 diffs)
• src/osgViewer/CompositeViewer.cpp (modified) (3 diffs)
• src/osgViewer/StatsHandler.cpp (modified) (1 diff)
• src/osgViewer/View.cpp (modified) (1 diff)
• src/osgViewer/Viewer.cpp (modified) (5 diffs)
• src/osgViewer/ViewerBase.cpp (modified) (5 diffs)
• src/osgViewer/ViewerEventHandlers.cpp (modified) (8 diffs)

OpenSceneGraph/trunk/include/osgViewer/CompositeViewer

@@ -74 +74 @@
 
         virtual double elapsedTime();
-        
+
         virtual osg::FrameStamp* getViewerFrameStamp() { return getFrameStamp(); }
-        
+
 
         /** Execute a main frame loop.
@@ -85 +85 @@
         virtual int run();
 
+        /** check to see if the new frame is required, called by run(..) when FrameScheme is set to ON_DEMAND.*/
+        virtual bool checkNeedToDoFrame();
+
         virtual void advance(double simulationTime=USE_REFERENCE_TIME);
 
@@ -90 +93 @@
 
         virtual void updateTraversal();
-        
-        
+
+
         void setCameraWithFocus(osg::Camera* camera);
         osg::Camera* getCameraWithFocus() { return _cameraWithFocus.get(); }
         const osg::Camera* getCameraWithFocus() const { return _cameraWithFocus.get(); }
-        
+
         osgViewer::View* getViewWithFocus() { return _viewWithFocus.get(); }
         const osgViewer::View* getViewWithFocus() const { return _viewWithFocus.get(); }

OpenSceneGraph/trunk/include/osgViewer/View

@@ -234 +234 @@
         osgUtil::SceneView::FusionDistanceMode  _fusionDistanceMode;
         float                                   _fusionDistanceValue;
+
 };
 

OpenSceneGraph/trunk/include/osgViewer/Viewer

@@ -36 +36 @@
 
         virtual ~Viewer();
-        
+
         META_Object(osgViewer,Viewer);
 
@@ -75 +75 @@
 
         virtual double elapsedTime();
-        
+
         virtual osg::FrameStamp* getViewerFrameStamp() { return getFrameStamp(); }
-
 
         /** Execute a main frame loop.
@@ -86 +85 @@
         virtual int run();
 
+        /** check to see if the new frame is required, called by run(..) when FrameScheme is set to ON_DEMAND.*/
+        virtual bool checkNeedToDoFrame();
+
         virtual void advance(double simulationTime=USE_REFERENCE_TIME);
 
@@ -91 +93 @@
 
         virtual void updateTraversal();
-        
+
         void setCameraWithFocus(osg::Camera* camera) { _cameraWithFocus = camera; }
         osg::Camera* getCameraWithFocus() { return _cameraWithFocus.get(); }
         const osg::Camera* getCameraWithFocus() const { return _cameraWithFocus.get(); }
-        
+
         virtual void getCameras(Cameras& cameras, bool onlyActive=true);
-        
+
         virtual void getContexts(Contexts& contexts, bool onlyValid=true);
 

OpenSceneGraph/trunk/include/osgViewer/ViewerBase

@@ -200 +200 @@
         void checkWindowStatus();
 
-
+        enum FrameScheme
+        {
+            ON_DEMAND,
+            CONTINUOUS
+        };
+
+        void setRunFrameScheme(FrameScheme fs) { _runFrameScheme = fs; }
+        FrameScheme getRunFrameScheme() const { return _runFrameScheme; }
+
+        void setRunMaxFrameRate(double frameRate) { _runMaxFrameRate = frameRate; }
+        double getRunMaxFrameRate() const { return _runMaxFrameRate; }
 
         /** Execute a main frame loop.
@@ -207 +217 @@
           * and installs trackball manipulator if one is not already assigned.
           */
-        virtual int run() = 0;
+        virtual int run();
+
+        /** check to see if the new frame is required, called by run(..) when FrameScheme is set to ON_DEMAND.*/
+        virtual bool checkNeedToDoFrame() = 0;
 
         /** Render a complete new frame.
@@ -250 +263 @@
         
     protected:
-    
+
+        void viewerBaseInit();
+
+        friend class osgViewer::View;
+
         inline void makeCurrent(osg::GraphicsContext* gc)
         {
             if (_currentContext==gc) return;
-            
+
             releaseContext();
-            
+
             if (gc && gc->valid() && gc->makeCurrent()) _currentContext = gc;
         }
-        
+
         inline void releaseContext()
         {
@@ -276 +293 @@
         bool                                                _quitEventSetsDone;
         bool                                                _releaseContextAtEndOfFrameHint;
-        
+
         ThreadingModel                                      _threadingModel;
         bool                                                _threadsRunning;
+
+        bool                                                _requestRedraw;
+        bool                                                _requestContinousUpdate;
+
+        FrameScheme                                         _runFrameScheme;
+        double                                              _runMaxFrameRate;
+
 
         BarrierPosition                                     _endBarrierPosition;
@@ -285 +309 @@
         osg::ref_ptr<osg::BarrierOperation>                 _endRenderingDispatchBarrier;
         osg::ref_ptr<osg::EndOfDynamicDrawBlock>            _endDynamicDrawBlock;
-        
+
         osg::ref_ptr<osgGA::EventVisitor>                   _eventVisitor;
-        
+
         osg::ref_ptr<osg::OperationQueue>                   _updateOperations;
         osg::ref_ptr<osgUtil::UpdateVisitor>                _updateVisitor;
-        
+
         osg::ref_ptr<osg::Operation>                        _realizeOperation;
         osg::ref_ptr<osgUtil::IncrementalCompileOperation>  _incrementalCompileOperation;

OpenSceneGraph/trunk/src/osgViewer/CompositeViewer.cpp

@@ -38 +38 @@
 {
     constructorInit();
-    
+
+    arguments.getApplicationUsage()->addCommandLineOption("--SingleThreaded","Select SingleThreaded threading model for viewer.");
+    arguments.getApplicationUsage()->addCommandLineOption("--CullDrawThreadPerContext","Select CullDrawThreadPerContext threading model for viewer.");
+    arguments.getApplicationUsage()->addCommandLineOption("--DrawThreadPerContext","Select DrawThreadPerContext threading model for viewer.");
+    arguments.getApplicationUsage()->addCommandLineOption("--CullThreadPerCameraDrawThreadPerContext","Select CullThreadPerCameraDrawThreadPerContext threading model for viewer.");
+
+    arguments.getApplicationUsage()->addCommandLineOption("--run-on-demand","Set the run methods frame rate management to only rendering frames when required.");
+    arguments.getApplicationUsage()->addCommandLineOption("--run-continuous","Set the run methods frame rate management to rendering frames continuously.");
+    arguments.getApplicationUsage()->addCommandLineOption("--run-max-frame-rate","Set the run methods maximum permissable frame rate, 0.0 is default and switching off frame rate capping.");
+
+
     std::string filename;
     bool readConfig = false;
@@ -51 +61 @@
     while (arguments.read("--CullThreadPerCameraDrawThreadPerContext")) setThreadingModel(CullThreadPerCameraDrawThreadPerContext);
 
+
+    while(arguments.read("--run-on-demand")) { setRunFrameScheme(ON_DEMAND); }
+    while(arguments.read("--run-continuous")) { setRunFrameScheme(CONTINUOUS); }
+
+    double runMaxFrameRate;
+    while(arguments.read("--run-max-frame-rate", runMaxFrameRate)) { setRunMaxFrameRate(runMaxFrameRate); }
+
+
     osg::DisplaySettings::instance()->readCommandLine(arguments);
     osgDB::readCommandLine(arguments);
@@ -221 +239 @@
     
     return numRealizedWindows > 0;
+}
+
+bool CompositeViewer::checkNeedToDoFrame()
+{
+    if (_requestRedraw) return true;
+    if (_requestContinousUpdate) return true;
+
+    for(RefViews::iterator itr = _views.begin();
+        itr != _views.end();
+        ++itr)
+    {
+        osgViewer::View* view = itr->get();
+        if (view)
+        {
+            // If the database pager is going to update the scene the render flag is
+            // set so that the updates show up
+            if (view->getDatabasePager()->requiresUpdateSceneGraph() ||
+                view->getDatabasePager()->getRequestsInProgress()) return true;
+        }
+    }
+
+    // now do a eventTraversal to see if any events might require a new frame.
+    eventTraversal();
+
+    if (_requestRedraw) return true;
+    if (_requestContinousUpdate) return true;
+
+    return false;
 }
 

OpenSceneGraph/trunk/src/osgViewer/StatsHandler.cpp

@@ -184 +184 @@
                     }
 
-
+                    aa.requestRedraw();
                 }
                 return true;

OpenSceneGraph/trunk/src/osgViewer/View.cpp

@@ -1697 +1697 @@
 void View::requestRedraw()
 {
-}
-
-void View::requestContinuousUpdate(bool)
-{
+    getViewerBase()->_requestRedraw = true;
+}
+
+void View::requestContinuousUpdate(bool flag)
+{
+    getViewerBase()->_requestContinousUpdate = flag;
 }
 

OpenSceneGraph/trunk/src/osgViewer/Viewer.cpp

@@ -54 +54 @@
     arguments.getApplicationUsage()->addCommandLineOption("--screen <num>","Set the screen to use when multiple screens are present.");
     arguments.getApplicationUsage()->addCommandLineOption("--window <x y w h>","Set the position (x,y) and size (w,h) of the viewer window.");
+
+    arguments.getApplicationUsage()->addCommandLineOption("--run-on-demand","Set the run methods frame rate management to only rendering frames when required.");
+    arguments.getApplicationUsage()->addCommandLineOption("--run-continuous","Set the run methods frame rate management to rendering frames continuously.");
+    arguments.getApplicationUsage()->addCommandLineOption("--run-max-frame-rate","Set the run methods maximum permissable frame rate, 0.0 is default and switching off frame rate capping.");
+
     // FIXME: Uncomment these lines when the options have been documented properly
     //arguments.getApplicationUsage()->addCommandLineOption("--3d-sd","");
@@ -85 +90 @@
         else osg::notify(osg::WARN)<<"Invalid clear color \""<<colorStr<<"\""<<std::endl;
     }
-    
+
+
+    while(arguments.read("--run-on-demand")) { setRunFrameScheme(ON_DEMAND); }
+    while(arguments.read("--run-continuous")) { setRunFrameScheme(CONTINUOUS); }
+
+    double runMaxFrameRate;
+    while(arguments.read("--run-max-frame-rate", runMaxFrameRate)) { setRunMaxFrameRate(runMaxFrameRate); }
+
+
     int screenNum = -1;
     while (arguments.read("--screen",screenNum)) {}
-    
+
     int x = -1, y = -1, width = -1, height = -1;
     while (arguments.read("--window",x,y,width,height)) {}
-    
+
     bool ss3d = false;
     bool wowvx20 = false;
@@ -310 +323 @@
 }
 
+bool Viewer::checkNeedToDoFrame()
+{
+    if (_requestRedraw) return true;
+    if (_requestContinousUpdate) return true;
+
+    // If the database pager is going to update the scene the render flag is
+    // set so that the updates show up
+    if(getDatabasePager()->requiresUpdateSceneGraph() || getDatabasePager()->getRequestsInProgress()) return true;
+
+    // now do a eventTraversal to see if any events might require a new frame.
+    eventTraversal();
+
+    if (_requestRedraw) return true;
+    if (_requestContinousUpdate) return true;
+
+    return false;
+}
+
 int Viewer::run()
 {
@@ -316 +347 @@
         setCameraManipulator(new osgGA::TrackballManipulator());
     }
-    
+
     setReleaseContextAtEndOfFrameHint(false);
-            
+
     return ViewerBase::run();
 }
@@ -325 +356 @@
 {
     View::setStartTick(tick);
-    
+
     Contexts contexts;
     getContexts(contexts,false);

OpenSceneGraph/trunk/src/osgViewer/ViewerBase.cpp

@@ -34 +34 @@
 static osg::ApplicationUsageProxy ViewerBase_e2(osg::ApplicationUsage::ENVIRONMENTAL_VARIABLE,"OSG_SCREEN <value>","Set the default screen that windows should open up on.");
 static osg::ApplicationUsageProxy ViewerBase_e3(osg::ApplicationUsage::ENVIRONMENTAL_VARIABLE,"OSG_WINDOW x y width height","Set the default window dimensions that windows should open up on.");
-
+static osg::ApplicationUsageProxy ViewerBase_e4(osg::ApplicationUsage::ENVIRONMENTAL_VARIABLE,"OSG_RUN_FRAME_SCHEME","Frame rate manage scheme that viewer run should use,  ON_DEMAND or CONTINUOUS (default).");
+static osg::ApplicationUsageProxy ViewerBase_e5(osg::ApplicationUsage::ENVIRONMENTAL_VARIABLE,"OSG_RUN_MAX_FRAME_RATE","Set the maximum number of frame as second that viewer run. 0.0 is default and disables an frame rate capping.");
 
 using namespace osgViewer;
@@ -40 +41 @@
 ViewerBase::ViewerBase():
     osg::Object(true)
+{
+    viewerBaseInit();
+}
+
+ViewerBase::ViewerBase(const ViewerBase& base):
+    osg::Object(true)
+{
+    viewerBaseInit();
+}
+
+void ViewerBase::viewerBaseInit()
 {
     _firstFrame = true;
@@ -49 +61 @@
     _threadsRunning = false;
     _endBarrierPosition = AfterSwapBuffers;
-}
-
-ViewerBase::ViewerBase(const ViewerBase& base):
-    osg::Object(true)
-{
-    _firstFrame = true;
-    _done = false;
-    _keyEventSetsDone = osgGA::GUIEventAdapter::KEY_Escape;
-    _quitEventSetsDone = true;
-    _releaseContextAtEndOfFrameHint = true;
-    _threadingModel = AutomaticSelection;
-    _threadsRunning = false;
-    _endBarrierPosition = AfterSwapBuffers;
+    _requestRedraw = true;
+    _requestContinousUpdate = false;
+
+    _runFrameScheme = CONTINUOUS;
+    _runMaxFrameRate = 0.0f;
+
+    const char* str = getenv("OSG_RUN_FRAME_SCHEME");
+    if (str)
+    {
+        if      (strcmp(str, "ON_DEMAND")==0) _runFrameScheme = ON_DEMAND;
+        else if (strcmp(str, "CONTINUOUS")==0) _runFrameScheme = CONTINUOUS;
+    }
+
+    str = getenv("OSG_RUN_MAX_FRAME_RATE");
+    if (str)
+    {
+        _runMaxFrameRate = atof(str);
+    }
 }
 
@@ -574 +591 @@
     }
 
-#if 0
-    while (!done())
-    {
-        frame();
-    }
-#else
-
     const char* str = getenv("OSG_RUN_FRAME_COUNT");
-    if (str)
-    {
-        int runTillFrameNumber = atoi(str);
-        while (!done() && getViewerFrameStamp()->getFrameNumber()<runTillFrameNumber)
+    int runTillFrameNumber = str==0 ? -1 : atoi(str);
+
+    while(!done() || (runTillFrameNumber>=0 && getViewerFrameStamp()->getFrameNumber()>runTillFrameNumber))
+    {
+        double minFrameTime = _runMaxFrameRate>0.0 ? 1.0/_runMaxFrameRate : 0.0;
+        osg::Timer_t startFrameTick = osg::Timer::instance()->tick();
+        if (_runFrameScheme==ON_DEMAND)
+        {
+            if (checkNeedToDoFrame()) frame();
+        }
+        else
         {
             frame();
         }
-    }
-    else
-    {
-        while (!done())
-        {
-            frame();
-        }
-    }
-#endif    
+
+        // work out if we need to force a sleep to hold back the frame rate
+        osg::Timer_t endFrameTick = osg::Timer::instance()->tick();
+        double frameTime = osg::Timer::instance()->delta_s(startFrameTick, endFrameTick);
+        if (frameTime < minFrameTime) OpenThreads::Thread::microSleep(1000000.0*(minFrameTime-frameTime));
+    }
+
     return 0;
 }
@@ -843 +858 @@
         getViewerStats()->setAttribute(frameStamp->getFrameNumber(), "Rendering traversals time taken", endRenderingTraversals-beginRenderingTraversals);
     }
-}
-
+
+    _requestRedraw = false;
+}
+

OpenSceneGraph/trunk/src/osgViewer/ViewerEventHandlers.cpp

@@ -101 +101 @@
                     toggleFullscreen(*itr);
                 }
+
+                aa.requestRedraw();
                 return true;
             }
@@ -115 +117 @@
                     changeWindowedResolution(*itr, true);
                 }
+
+                aa.requestRedraw();
                 return true;
             }
@@ -129 +133 @@
                     changeWindowedResolution(*itr, false);
                 }
+
+                aa.requestRedraw();
                 return true;
             }
@@ -318 +324 @@
             if (_changeThreadingModel == true && ea.getKey() == _keyEventChangeThreadingModel && delta > 1.0)
             {
+
                 _tickOrLastKeyPress = osg::Timer::instance()->tick();
 
@@ -349 +356 @@
                     break;
                 }
+
+                aa.requestRedraw();
                 return true;
             }
@@ -364 +373 @@
                     break;
                 }
+
+                aa.requestRedraw();
                 return true;
             }
@@ -576 +587 @@
                 camera->setLODScale(camera->getLODScale()*1.1);
                 osg::notify(osg::NOTICE)<<"LODScale = "<<camera->getLODScale()<<std::endl;
+
+                aa.requestRedraw();
                 return true;
             }
@@ -583 +596 @@
                 camera->setLODScale(camera->getLODScale()/1.1);
                 osg::notify(osg::NOTICE)<<"LODScale = "<<camera->getLODScale()<<std::endl;
-                return true;
-            }        
+
+                aa.requestRedraw();
+                return true;
+            }
 
             break;