src/Viewer/fg_os_osgviewer.cxx

   1 // fg_os_osgviewer.cxx -- common functions for fg_os interface
   2 // implemented as an osgViewer
   3 //
   4 // Copyright (C) 2007  Tim Moore timoore@redhat.com
   5 // Copyright (C) 2007 Mathias Froehlich
   6 //
   7 // This program is free software; you can redistribute it and/or
   8 // modify it under the terms of the GNU General Public License as
   9 // published by the Free Software Foundation; either version 2 of the
  10 // License, or (at your option) any later version.
  11 //
  12 // This program is distributed in the hope that it will be useful, but
  13 // WITHOUT ANY WARRANTY; without even the implied warranty of
  14 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15 // General Public License for more details.
  16 //
  17 // You should have received a copy of the GNU General Public License
  18 // along with this program; if not, write to the Free Software
  19 // Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  20
  21 #ifdef HAVE_CONFIG_H
  22 #include <config.h>
  23 #endif
  24
  25 #include <algorithm>
  26 #include <iostream>
  27 #include <sstream>
  28 #include <string>
  29
  30 #include <stdlib.h>
  31
  32 // Boost
  33 #include <boost/algorithm/string/case_conv.hpp>
  34 #include <boost/foreach.hpp>
  35
  36 #include <simgear/compiler.h>
  37 #include <simgear/structure/exception.hxx>
  38 #include <simgear/debug/logstream.hxx>
  39 #include <simgear/props/props_io.hxx>
  40
  41 #include <osg/Camera>
  42 #include <osg/GraphicsContext>
  43 #include <osg/Group>
  44 #include <osg/Matrixd>
  45 #include <osg/Viewport>
  46 #include <osg/Version>
  47 #include <osg/Notify>
  48 #include <osg/View>
  49 #include <osgViewer/ViewerEventHandlers>
  50 #include <osgViewer/Viewer>
  51 #include <osgViewer/GraphicsWindow>
  52
  53 #include <Scenery/scenery.hxx>
  54 #include <Main/fg_os.hxx>
  55 #include <Main/fg_props.hxx>
  56 #include <Main/util.hxx>
  57 #include <Main/globals.hxx>
  58 #include "renderer.hxx"
  59 #include "CameraGroup.hxx"
  60 #include "FGEventHandler.hxx"
  61 #include "WindowBuilder.hxx"
  62 #include "WindowSystemAdapter.hxx"
  63
  64 // Static linking of OSG needs special macros
  65 #ifdef OSG_LIBRARY_STATIC
  66 #include <osgDB/Registry>
  67 USE_GRAPHICSWINDOW();
  68 // Image formats
  69 USE_OSGPLUGIN(bmp);
  70 USE_OSGPLUGIN(dds);
  71 USE_OSGPLUGIN(hdr);
  72 USE_OSGPLUGIN(pic);
  73 USE_OSGPLUGIN(pnm);
  74 USE_OSGPLUGIN(rgb);
  75 USE_OSGPLUGIN(tga);
  76 #ifdef OSG_JPEG_ENABLED
  77   USE_OSGPLUGIN(jpeg);
  78 #endif
  79 #ifdef OSG_PNG_ENABLED
  80   USE_OSGPLUGIN(png);
  81 #endif
  82 #ifdef OSG_TIFF_ENABLED
  83   USE_OSGPLUGIN(tiff);
  84 #endif
  85 // Model formats
  86 USE_OSGPLUGIN(3ds);
  87 USE_OSGPLUGIN(ac);
  88 USE_OSGPLUGIN(ive);
  89 USE_OSGPLUGIN(osg);
  90 USE_OSGPLUGIN(txf);
  91 #endif
  92
  93 // fg_os implementation using OpenSceneGraph's osgViewer::Viewer class
  94 // to create the graphics window and run the event/update/render loop.
  95
  96 //
  97 // fg_os implementation
  98 //
  99
 100 using namespace std;
 101 using namespace flightgear;
 102 using namespace osg;
 103
 104 static osg::ref_ptr<osgViewer::Viewer> viewer;
 105 static osg::ref_ptr<osg::Camera> mainCamera;
 106
 107 static void setStereoMode( const char * mode )
 108 {
 109     DisplaySettings::StereoMode stereoMode = DisplaySettings::QUAD_BUFFER;
 110     bool stereoOn = true;
 111
 112     if (strcmp(mode,"QUAD_BUFFER")==0)
 113     {
 114         stereoMode = DisplaySettings::QUAD_BUFFER;
 115     }
 116     else if (strcmp(mode,"ANAGLYPHIC")==0)
 117     {
 118         stereoMode = DisplaySettings::ANAGLYPHIC;
 119     }
 120     else if (strcmp(mode,"HORIZONTAL_SPLIT")==0)
 121     {
 122         stereoMode = DisplaySettings::HORIZONTAL_SPLIT;
 123     }
 124     else if (strcmp(mode,"VERTICAL_SPLIT")==0)
 125     {
 126         stereoMode = DisplaySettings::VERTICAL_SPLIT;
 127     }
 128     else if (strcmp(mode,"LEFT_EYE")==0)
 129     {
 130         stereoMode = DisplaySettings::LEFT_EYE;
 131     }
 132     else if (strcmp(mode,"RIGHT_EYE")==0)
 133     {
 134         stereoMode = DisplaySettings::RIGHT_EYE;
 135     }
 136     else if (strcmp(mode,"HORIZONTAL_INTERLACE")==0)
 137     {
 138         stereoMode = DisplaySettings::HORIZONTAL_INTERLACE;
 139     }
 140     else if (strcmp(mode,"VERTICAL_INTERLACE")==0)
 141     {
 142         stereoMode = DisplaySettings::VERTICAL_INTERLACE;
 143     }
 144     else if (strcmp(mode,"CHECKERBOARD")==0)
 145     {
 146         stereoMode = DisplaySettings::CHECKERBOARD;
 147     } else {
 148         stereoOn = false;
 149     }
 150     DisplaySettings::instance()->setStereo( stereoOn );
 151     DisplaySettings::instance()->setStereoMode( stereoMode );
 152 }
 153
 154 static const char * getStereoMode()
 155 {
 156     DisplaySettings::StereoMode stereoMode = DisplaySettings::instance()->getStereoMode();
 157     bool stereoOn = DisplaySettings::instance()->getStereo();
 158     if( !stereoOn ) return "OFF";
 159     if( stereoMode == DisplaySettings::QUAD_BUFFER ) {
 160         return "QUAD_BUFFER";
 161     } else if( stereoMode == DisplaySettings::ANAGLYPHIC ) {
 162         return "ANAGLYPHIC";
 163     } else if( stereoMode == DisplaySettings::HORIZONTAL_SPLIT ) {
 164         return "HORIZONTAL_SPLIT";
 165     } else if( stereoMode == DisplaySettings::VERTICAL_SPLIT ) {
 166         return "VERTICAL_SPLIT";
 167     } else if( stereoMode == DisplaySettings::LEFT_EYE ) {
 168         return "LEFT_EYE";
 169     } else if( stereoMode == DisplaySettings::RIGHT_EYE ) {
 170         return "RIGHT_EYE";
 171     } else if( stereoMode == DisplaySettings::HORIZONTAL_INTERLACE ) {
 172         return "HORIZONTAL_INTERLACE";
 173     } else if( stereoMode == DisplaySettings::VERTICAL_INTERLACE ) {
 174         return "VERTICAL_INTERLACE";
 175     } else if( stereoMode == DisplaySettings::CHECKERBOARD ) {
 176         return "CHECKERBOARD";
 177     }
 178     return "OFF";
 179 }
 180
 181 /**
 182  * merge OSG output into our logging system, so it gets recorded to file,
 183  * and so we can display a GUI console with renderer issues, especially
 184  * shader compilation warnings and errors.
 185  */
 186 class NotifyLogger : public osg::NotifyHandler
 187 {
 188 public:
 189   // note this callback will be invoked by OSG from multiple threads.
 190   // fortunately our Simgear logging implementation already handles
 191   // that internally, so we simply pass the message on.
 192   virtual void notify(osg::NotifySeverity severity, const char *message)
 193   {
 194     SG_LOG(SG_GL, translateSeverity(severity), message);
 195
 196     // Detect whether a osg::Reference derived object is deleted with a non-zero
 197     // reference count. In this case trigger a segfault to get a stack trace.
 198     if( strstr(message, "the final reference count was") )
 199     {
 200
 201       int* trigger_segfault = 0;
 202       *trigger_segfault = 0;
 203     }
 204   }
 205
 206 private:
 207   sgDebugPriority translateSeverity(osg::NotifySeverity severity)
 208   {
 209     switch (severity) {
 210       case osg::ALWAYS:
 211       case osg::FATAL:  return SG_ALERT;
 212       case osg::WARN:   return SG_WARN;
 213       case osg::NOTICE:
 214       case osg::INFO:   return SG_INFO;
 215       case osg::DEBUG_FP:
 216       case osg::DEBUG_INFO: return SG_DEBUG;
 217       default: return SG_ALERT;
 218     }
 219   }
 220 };
 221
 222 class NotifyLevelListener : public SGPropertyChangeListener
 223 {
 224 public:
 225     void valueChanged(SGPropertyNode* node)
 226     {
 227         osg::NotifySeverity severity = osg::WARN;
 228         string val = boost::to_lower_copy(string(node->getStringValue()));
 229
 230         if (val == "fatal") {
 231             severity = osg::FATAL;
 232         } else if (val == "warn") {
 233             severity = osg::WARN;
 234         } else if (val == "notice") {
 235             severity = osg::NOTICE;
 236         } else if (val == "info") {
 237             severity = osg::INFO;
 238         } else if ((val == "debug") || (val == "debug-info")) {
 239             severity = osg::DEBUG_INFO;
 240         }
 241
 242         osg::setNotifyLevel(severity);
 243     }
 244 };
 245
 246 void updateOSGNotifyLevel()
 247 {
 248    }
 249
 250 void fgOSOpenWindow(bool stencil)
 251 {
 252     osg::setNotifyHandler(new NotifyLogger);
 253
 254     SGPropertyNode* osgLevel = fgGetNode("/sim/rendering/osg-notify-level", true);
 255     osgLevel->addChangeListener(new NotifyLevelListener, true);
 256
 257     viewer = new osgViewer::Viewer;
 258     viewer->setDatabasePager(FGScenery::getPagerSingleton());
 259     CameraGroup* cameraGroup = 0;
 260     std::string mode;
 261     mode = fgGetString("/sim/rendering/multithreading-mode", "SingleThreaded");
 262     if (mode == "AutomaticSelection")
 263       viewer->setThreadingModel(osgViewer::Viewer::AutomaticSelection);
 264     else if (mode == "CullDrawThreadPerContext")
 265       viewer->setThreadingModel(osgViewer::Viewer::CullDrawThreadPerContext);
 266     else if (mode == "DrawThreadPerContext")
 267       viewer->setThreadingModel(osgViewer::Viewer::DrawThreadPerContext);
 268     else if (mode == "CullThreadPerCameraDrawThreadPerContext")
 269       viewer->setThreadingModel(osgViewer::Viewer::CullThreadPerCameraDrawThreadPerContext);
 270     else
 271       viewer->setThreadingModel(osgViewer::Viewer::SingleThreaded);
 272     WindowBuilder::initWindowBuilder(stencil);
 273     WindowBuilder *windowBuilder = WindowBuilder::getWindowBuilder();
 274
 275     // Look for windows, camera groups, and the old syntax of
 276     // top-level cameras
 277     SGPropertyNode* renderingNode = fgGetNode("/sim/rendering");
 278     SGPropertyNode* cgroupNode = renderingNode->getNode("camera-group", true);
 279     bool oldSyntax = !cgroupNode->hasChild("camera");
 280     if (oldSyntax) {
 281         for (int i = 0; i < renderingNode->nChildren(); ++i) {
 282             SGPropertyNode* propNode = renderingNode->getChild(i);
 283             const char* propName = propNode->getName();
 284             if (!strcmp(propName, "window") || !strcmp(propName, "camera")) {
 285                 SGPropertyNode* copiedNode
 286                     = cgroupNode->getNode(propName, propNode->getIndex(), true);
 287                 copyProperties(propNode, copiedNode);
 288             }
 289         }
 290         vector<SGPropertyNode_ptr> cameras = cgroupNode->getChildren("camera");
 291         SGPropertyNode* masterCamera = 0;
 292         BOOST_FOREACH(SGPropertyNode_ptr& camera, cameras) {
 293             if (camera->getDoubleValue("shear-x", 0.0) == 0.0
 294                 && camera->getDoubleValue("shear-y", 0.0) == 0.0) {
 295                 masterCamera = camera.ptr();
 296                 break;
 297             }
 298         }
 299         if (!masterCamera) {
 300             masterCamera = cgroupNode->getChild("camera", cameras.size(), true);
 301             setValue(masterCamera->getNode("window/name", true),
 302                      windowBuilder->getDefaultWindowName());
 303         }
 304         SGPropertyNode* nameNode = masterCamera->getNode("window/name");
 305         if (nameNode)
 306             setValue(cgroupNode->getNode("gui/window/name", true),
 307                      nameNode->getStringValue());
 308     }
 309     cameraGroup = CameraGroup::buildCameraGroup(viewer.get(), cgroupNode);
 310     Camera* guiCamera = getGUICamera(cameraGroup);
 311     if (guiCamera) {
 312         Viewport* guiViewport = guiCamera->getViewport();
 313         fgSetInt("/sim/startup/xsize", guiViewport->width());
 314         fgSetInt("/sim/startup/ysize", guiViewport->height());
 315     }
 316     FGEventHandler* manipulator = globals->get_renderer()->getEventHandler();
 317     WindowSystemAdapter* wsa = WindowSystemAdapter::getWSA();
 318     if (wsa->windows.size() != 1) {
 319         manipulator->setResizable(false);
 320     }
 321     viewer->getCamera()->setProjectionResizePolicy(osg::Camera::FIXED);
 322     viewer->addEventHandler(manipulator);
 323     // Let FG handle the escape key with a confirmation
 324     viewer->setKeyEventSetsDone(0);
 325     // The viewer won't start without some root.
 326     viewer->setSceneData(new osg::Group);
 327     globals->get_renderer()->setViewer(viewer.get());
 328     CameraGroup::setDefault(cameraGroup);
 329
 330     DisplaySettings * displaySettings = DisplaySettings::instance();
 331     fgTie("/sim/rendering/osg-displaysettings/eye-separation", displaySettings, &DisplaySettings::getEyeSeparation, &DisplaySettings::setEyeSeparation );
 332     fgTie("/sim/rendering/osg-displaysettings/screen-distance", displaySettings, &DisplaySettings::getScreenDistance, &DisplaySettings::setScreenDistance );
 333     fgTie("/sim/rendering/osg-displaysettings/screen-width", displaySettings, &DisplaySettings::getScreenWidth, &DisplaySettings::setScreenWidth );
 334     fgTie("/sim/rendering/osg-displaysettings/screen-height", displaySettings, &DisplaySettings::getScreenHeight, &DisplaySettings::setScreenHeight );
 335     fgTie("/sim/rendering/osg-displaysettings/stereo-mode", getStereoMode, setStereoMode );
 336     fgTie("/sim/rendering/osg-displaysettings/double-buffer", displaySettings, &DisplaySettings::getDoubleBuffer, &DisplaySettings::setDoubleBuffer );
 337     fgTie("/sim/rendering/osg-displaysettings/depth-buffer", displaySettings, &DisplaySettings::getDepthBuffer, &DisplaySettings::setDepthBuffer );
 338     fgTie("/sim/rendering/osg-displaysettings/rgb", displaySettings, &DisplaySettings::getRGB, &DisplaySettings::setRGB );
 339 }
 340
 341
 342 static int status = 0;
 343
 344 void fgOSExit(int code)
 345 {
 346     viewer->setDone(true);
 347     viewer->getDatabasePager()->cancel();
 348     status = code;
 349 }
 350
 351 int fgOSMainLoop()
 352 {
 353     ref_ptr<FGEventHandler> manipulator
 354         = globals->get_renderer()->getEventHandler();
 355     viewer->setReleaseContextAtEndOfFrameHint(false);
 356     if (!viewer->isRealized())
 357         viewer->realize();
 358     while (!viewer->done()) {
 359         fgIdleHandler idleFunc = manipulator->getIdleHandler();
 360         if (idleFunc)
 361             (*idleFunc)();
 362         globals->get_renderer()->update();
 363         viewer->frame( globals->get_sim_time_sec() );
 364     }
 365
 366     return status;
 367 }
 368
 369 int fgGetKeyModifiers()
 370 {
 371     if (!globals->get_renderer()) { // happens during shutdown
 372       return 0;
 373     }
 374
 375     return globals->get_renderer()->getEventHandler()->getCurrentModifiers();
 376 }
 377
 378 void fgWarpMouse(int x, int y)
 379 {
 380     warpGUIPointer(CameraGroup::getDefault(), x, y);
 381 }
 382
 383 void fgOSInit(int* argc, char** argv)
 384 {
 385     globals->get_renderer()->init();
 386     WindowSystemAdapter::setWSA(new WindowSystemAdapter);
 387 }
 388
 389 void fgOSCloseWindow()
 390 {
 391     FGScenery::resetPagerSingleton();
 392     mainCamera = NULL;
 393     flightgear::CameraGroup::setDefault(NULL);
 394     WindowSystemAdapter::setWSA(NULL);
 395     viewer = NULL;
 396 }
 397
 398 void fgOSFullScreen()
 399 {
 400     std::vector<osgViewer::GraphicsWindow*> windows;
 401     viewer->getWindows(windows);
 402
 403     if (windows.empty())
 404         return; // Huh?!?
 405
 406     /* Toggling window fullscreen is only supported for the main GUI window.
 407      * The other windows should use fixed setup from the camera.xml file anyway. */
 408     osgViewer::GraphicsWindow* window = windows[0];
 409
 410     {
 411         osg::GraphicsContext::WindowingSystemInterface    *wsi = osg::GraphicsContext::getWindowingSystemInterface();
 412
 413         if (wsi == NULL)
 414         {
 415             SG_LOG(SG_VIEW, SG_ALERT, "ERROR: No WindowSystemInterface available. Cannot toggle window fullscreen.");
 416             return;
 417         }
 418
 419         static int previous_x = 0;
 420         static int previous_y = 0;
 421         static int previous_width = 800;
 422         static int previous_height = 600;
 423
 424         unsigned int screenWidth;
 425         unsigned int screenHeight;
 426         wsi->getScreenResolution(*(window->getTraits()), screenWidth, screenHeight);
 427
 428         int x;
 429         int y;
 430         int width;
 431         int height;
 432         window->getWindowRectangle(x, y, width, height);
 433
 434         /* Note: the simple "is window size == screen size" check to detect full screen state doesn't work with
 435          * X screen servers in Xinerama mode, since the reported screen width (or height) exceeds the maximum width
 436          * (or height) usable by a single window (Xserver automatically shrinks/moves the full screen window to fit a
 437          * single display) - so we detect full screen mode using "WindowDecoration" state instead.
 438          * "false" - even when a single window is display in fullscreen */
 439         //bool isFullScreen = x == 0 && y == 0 && width == (int)screenWidth && height == (int)screenHeight;
 440         bool isFullScreen = !window->getWindowDecoration();
 441
 442         SG_LOG(SG_VIEW, SG_DEBUG, "Toggling fullscreen. Previous window rectangle ("
 443                << x << ", " << y << ") x (" << width << ", " << height << "), fullscreen: " << isFullScreen
 444                << ", number of screens: " << wsi->getNumScreens());
 445         if (isFullScreen)
 446         {
 447             // limit x,y coordinates and window size to screen area
 448             if (previous_x + previous_width > (int)screenWidth)
 449                 previous_x = 0;
 450             if (previous_y + previous_height > (int)screenHeight)
 451                 previous_y = 0;
 452
 453             // disable fullscreen mode, restore previous window size/coordinates
 454             x = previous_x;
 455             y = previous_y;
 456             width = previous_width;
 457             height = previous_height;
 458         }
 459         else
 460         {
 461             // remember previous setting
 462             previous_x = x;
 463             previous_y = y;
 464             previous_width = width;
 465             previous_height = height;
 466
 467             // enable fullscreen mode, set new width/height
 468             x = 0;
 469             y = 0;
 470             width = screenWidth;
 471             height = screenHeight;
 472         }
 473
 474         // set xsize/ysize properties to adapt GUI planes
 475         fgSetInt("/sim/startup/xsize", width);
 476         fgSetInt("/sim/startup/ysize", height);
 477
 478         // reconfigure window
 479         window->setWindowDecoration(isFullScreen);
 480         window->setWindowRectangle(x, y, width, height);
 481         window->grabFocusIfPointerInWindow();
 482     }
 483 }
 484
 485 static void setMouseCursor(osgViewer::GraphicsWindow* gw, int cursor)
 486 {
 487     if (!gw) {
 488         return;
 489     }
 490
 491     osgViewer::GraphicsWindow::MouseCursor mouseCursor;
 492     mouseCursor = osgViewer::GraphicsWindow::InheritCursor;
 493     if (cursor == MOUSE_CURSOR_NONE)
 494         mouseCursor = osgViewer::GraphicsWindow::NoCursor;
 495     else if(cursor == MOUSE_CURSOR_POINTER)
 496 #ifdef SG_MAC
 497         // osgViewer-Cocoa lacks RightArrowCursor, use Left
 498         mouseCursor = osgViewer::GraphicsWindow::LeftArrowCursor;
 499 #else
 500         mouseCursor = osgViewer::GraphicsWindow::RightArrowCursor;
 501 #endif
 502     else if(cursor == MOUSE_CURSOR_WAIT)
 503         mouseCursor = osgViewer::GraphicsWindow::WaitCursor;
 504     else if(cursor == MOUSE_CURSOR_CROSSHAIR)
 505         mouseCursor = osgViewer::GraphicsWindow::CrosshairCursor;
 506     else if(cursor == MOUSE_CURSOR_LEFTRIGHT)
 507         mouseCursor = osgViewer::GraphicsWindow::LeftRightCursor;
 508     else if(cursor == MOUSE_CURSOR_TOPSIDE)
 509         mouseCursor = osgViewer::GraphicsWindow::TopSideCursor;
 510     else if(cursor == MOUSE_CURSOR_BOTTOMSIDE)
 511         mouseCursor = osgViewer::GraphicsWindow::BottomSideCursor;
 512     else if(cursor == MOUSE_CURSOR_LEFTSIDE)
 513         mouseCursor = osgViewer::GraphicsWindow::LeftSideCursor;
 514     else if(cursor == MOUSE_CURSOR_RIGHTSIDE)
 515         mouseCursor = osgViewer::GraphicsWindow::RightSideCursor;
 516     else if(cursor == MOUSE_CURSOR_TOPLEFT)
 517         mouseCursor = osgViewer::GraphicsWindow::TopLeftCorner;
 518     else if(cursor == MOUSE_CURSOR_TOPRIGHT)
 519         mouseCursor = osgViewer::GraphicsWindow::TopRightCorner;
 520     else if(cursor == MOUSE_CURSOR_BOTTOMLEFT)
 521         mouseCursor = osgViewer::GraphicsWindow::BottomLeftCorner;
 522     else if(cursor == MOUSE_CURSOR_BOTTOMRIGHT)
 523         mouseCursor = osgViewer::GraphicsWindow::BottomRightCorner;
 524
 525     gw->setCursor(mouseCursor);
 526 }
 527
 528 static int _cursor = -1;
 529
 530 void fgSetMouseCursor(int cursor)
 531 {
 532     _cursor = cursor;
 533     if (!viewer)
 534         return;
 535
 536     std::vector<osgViewer::GraphicsWindow*> windows;
 537     viewer->getWindows(windows);
 538     BOOST_FOREACH(osgViewer::GraphicsWindow* gw, windows) {
 539         setMouseCursor(gw, cursor);
 540     }
 541 }
 542
 543 int fgGetMouseCursor()
 544 {
 545     return _cursor;
 546 }