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