Implement view screenshot feature

Eyescale · Jan 9, 2017 · 9440d9f · 9440d9f
1 parent 3537b31
commit 9440d9f
Show file tree

Hide file tree

Showing 18 changed files with 398 additions and 55 deletions.
diff --git a/doc/Changelog.md b/doc/Changelog.md
@@ -6,6 +6,8 @@ Changelog {#Changelog}
 * [608](https://github.com/Eyescale/Equalizer/pull/608):
   Make Frame::Buffer enum an enum class to ease bitmask handling;
   enum values are now Frame::Buffer::value instead of Frame::BUFFER_VALUE
+* [607](https://github.com/Eyescale/Equalizer/pull/607):
+  Implement view screenshot feature with eq::View::enableScreenshot()
 * [606](https://github.com/Eyescale/Equalizer/pull/606):
   Remove unused big-endian/byteswap support
 * [601](https://github.com/Eyescale/Equalizer/pull/601):

diff --git a/eq/channel.cpp b/eq/channel.cpp
@@ -1439,8 +1439,7 @@ void Channel::_transmitImage( const co::ObjectVersion& frameDataVersion,
 
         if( isCompressed )
         {
-            BOOST_FOREACH( const pression::CompressorChunk& chunk,
-                           data->compressedData.chunks )
+            for( const auto& chunk :  data->compressedData.chunks )
             {
                 const uint64_t dataSize = chunk.getNumBytes();
 

diff --git a/eq/config.cpp b/eq/config.cpp
@@ -1,5 +1,5 @@
 
-/* Copyright (c) 2005-2016, Stefan Eilemann <eile@equalizergraphics.com>
+/* Copyright (c) 2005-2017, Stefan Eilemann <eile@equalizergraphics.com>
  *                          Daniel Nachbaur <danielnachbaur@gmail.com>
  *                          Cedric Stalder <cedric Stalder@gmail.com>
  *
@@ -36,9 +36,9 @@
 #include "view.h"
 #include "window.h"
 
-#include <eq/fabric/commands.h>
 #include <eq/fabric/axisEvent.h>
 #include <eq/fabric/buttonEvent.h>
+#include <eq/fabric/commands.h>
 #include <eq/fabric/keyEvent.h>
 #include <eq/fabric/pointerEvent.h>
 #include <eq/fabric/sizeEvent.h>
@@ -668,6 +668,16 @@ bool Config::handleEvent( EventICommand command )
         return false;
     }
 
+    case EVENT_VIEW_SCREENSHOT:
+    {
+        const uint128_t& originator = command.read< uint128_t >();
+        LBASSERT( originator != 0 );
+        View* view = find< View >( originator );
+        if( view )
+            return view->handleEvent( command );
+        return false;
+    }
+
     case EVENT_NODE_TIMEOUT:
     case EVENT_WINDOW_SCREENSAVER:
 

diff --git a/eq/detail/channel.ipp b/eq/detail/channel.ipp
@@ -22,8 +22,6 @@
 #include "../resultImageListener.h"
 #include "fileFrameWriter.h"
 
-#include <boost/foreach.hpp>
-
 #ifdef EQUALIZER_USE_DEFLECT
 #  include "../deflect/proxy.h"
 #endif
@@ -101,29 +99,49 @@ public:
         }
 #endif
 
-        if( resultImageListeners.empty( ))
+        eq::View* view = channel.getView();
+        eq::Frame::Buffer buffers = view->getScreenshotBuffers();
+        if( !resultImageListeners.empty( ))
+            buffers |= eq::Frame::Buffer::color;
+
+        if( buffers == eq::Frame::Buffer::none )
             return;
 
-        downloadFramebuffer( channel );
-        BOOST_FOREACH( ResultImageListener* listener, resultImageListeners )
+        downloadFramebuffer( channel, buffers );
+        for( ResultImageListener* listener : resultImageListeners )
             listener->notifyNewImage( channel, framebufferImage );
+
+        if( view->getScreenshotBuffers() != eq::Frame::Buffer::none )
+        {
+            view->sendScreenshotEvent( channel.getViewport(),
+                                       channel.getPipe()->getCurrentFrame(),
+                                       framebufferImage );
+        }
     }
 
-    void downloadFramebuffer( eq::Channel& channel )
+    void downloadFramebuffer( eq::Channel& channel,
+                              const eq::Frame::Buffer buffers )
     {
         framebufferImage.setAlphaUsage( true );
         framebufferImage.setQuality( eq::Frame::Buffer::color, 1.0f );
         framebufferImage.setStorageType( eq::Frame::TYPE_MEMORY );
         framebufferImage.setInternalFormat( eq::Frame::Buffer::color, GL_RGBA );
 
-        if( framebufferImage.startReadback( eq::Frame::Buffer::color,
+        if( buffers & eq::Frame::Buffer::color )
+            framebufferImage.startReadback( eq::Frame::Buffer::color,
                                             channel.getPixelViewport(),
                                             channel.getContext(),
                                             channel.getZoom(),
-                                            channel.getObjectManager( )))
-        {
-            framebufferImage.finishReadback( channel.glewGetContext( ));
-        }
+                                            channel.getObjectManager( ));
+
+        if( buffers & eq::Frame::Buffer::depth )
+            framebufferImage.startReadback( eq::Frame::Buffer::depth,
+                                            channel.getPixelViewport(),
+                                            channel.getContext(),
+                                            channel.getZoom(),
+                                            channel.getObjectManager( ));
+
+        framebufferImage.finishReadback( channel.glewGetContext( ));
     }
 
     /** The configInit/configExit state. */

diff --git a/eq/fabric/eventType.h b/eq/fabric/eventType.h
@@ -1,5 +1,5 @@
 
-/* Copyright (c) 2016, Stefan.Eilemann@epfl.ch
+/* Copyright (c) 2016-2017, Stefan.Eilemann@epfl.ch
  *
  * 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
@@ -83,6 +83,8 @@ enum EventType // Also update string table in event.cpp
     EVENT_WINDOW_ERROR, //!< Window error event. @sa CONFIG_ERROR
     EVENT_CHANNEL_ERROR, //!< Channel error event. @sa CONFIG_ERROR
 
+    EVENT_VIEW_SCREENSHOT, //!< Viewport, frameNumber, Image with requested buffers
+
     // todo
     EVENT_NODE_TIMEOUT,         //!< Node has timed out
     EVENT_WINDOW_SCREENSAVER,   //!< A window screensaver request (Win32 only)

diff --git a/eq/fabric/view.h b/eq/fabric/view.h
@@ -1,5 +1,5 @@
 
-/* Copyright (c) 2008-2015, Stefan Eilemann <eile@equalizergraphics.com>
+/* Copyright (c) 2008-2017, Stefan Eilemann <eile@equalizergraphics.com>
  *                          Daniel Nachbaur <danielnachbaur@gmail.com>
  *                          Cedric Stalder <cedric.stalder@gmail.com>
  *
@@ -21,11 +21,12 @@
 #define EQFABRIC_VIEW_H
 
 #include <eq/fabric/api.h>
-#include <eq/fabric/equalizer.h>      // member
-#include <eq/fabric/frustum.h>        // base class
-#include <eq/fabric/object.h>         // base class
+#include <eq/fabric/equalizer.h> // member
+#include <eq/fabric/frame.h>     // enum Frame::Buffer
+#include <eq/fabric/frustum.h>   // base class
+#include <eq/fabric/object.h>    // base class
 #include <eq/fabric/types.h>
-#include <eq/fabric/viewport.h>       // member
+#include <eq/fabric/viewport.h>  // member
 
 #define EQ_MM 1000.f
 #define EQ_CM 100.f
@@ -208,6 +209,12 @@ class View : public Object, public Frustum
      * @version 1.0
      */
     EQFABRIC_INL uint64_t getCapabilities() const;
+
+    /**
+     * @return the currently set buffers for screenshot feature
+     * @version 2.1
+     */
+    EQFABRIC_INL Frame::Buffer getScreenshotBuffers() const;
     //@}
 
     void setCapabilities( const uint64_t bitmask ); //!< @internal
@@ -228,11 +235,12 @@ class View : public Object, public Frustum
         DIRTY_EQUALIZERS     = Object::DIRTY_CUSTOM << 9,
         DIRTY_MODELUNIT      = Object::DIRTY_CUSTOM << 10,
         DIRTY_ATTRIBUTES     = Object::DIRTY_CUSTOM << 11,
+        DIRTY_SCREENSHOT     = Object::DIRTY_CUSTOM << 12,
         DIRTY_VIEW_BITS =
         DIRTY_VIEWPORT | DIRTY_OBSERVER | DIRTY_OVERDRAW |
         DIRTY_FRUSTUM | DIRTY_MODE | DIRTY_MINCAPS | DIRTY_MAXCAPS |
         DIRTY_CAPABILITIES | DIRTY_OBJECT_BITS | DIRTY_EQUALIZER |
-        DIRTY_EQUALIZERS | DIRTY_MODELUNIT | DIRTY_ATTRIBUTES
+        DIRTY_EQUALIZERS | DIRTY_MODELUNIT | DIRTY_ATTRIBUTES | DIRTY_SCREENSHOT
     };
 
     /** String attributes. */
@@ -295,6 +303,9 @@ class View : public Object, public Frustum
     /** @internal */
     virtual void notifyFrustumChanged() { setDirty( DIRTY_FRUSTUM ); }
 
+    /** @internal */
+    void _setScreenshotBuffers( Frame::Buffer buffers );
+
 private:
     /** Parent layout (application-side). */
     L* const _layout;
@@ -311,6 +322,7 @@ class View : public Object, public Frustum
     uint64_t _capabilities; //!< intersection of all active channel caps
     uint32_t _equalizers; //!< Active Equalizers
     float _modelUnit; //!< Scaling of scene in this view
+    Frame::Buffer _screenshotBuffers;
 
     struct BackupData
     {
@@ -325,9 +337,6 @@ class View : public Object, public Frustum
 
     /** String attributes. */
     std::string _sAttributes[SATTR_ALL];
-
-    struct Private;
-    Private* _private; // placeholder for binary-compatible changes
 };
 
 template< class L, class V, class O >

diff --git a/eq/fabric/view.ipp b/eq/fabric/view.ipp
@@ -1,5 +1,5 @@
 
-/* Copyright (c) 2008-2016, Stefan Eilemann <eile@equalizergraphics.com>
+/* Copyright (c) 2008-2017, Stefan Eilemann <eile@equalizergraphics.com>
  *                          Daniel Nachbaur <danielnachbaur@gmail.com>
  *                          Cedric Stalder <cedric.stalder@gmail.com>
  *
@@ -49,6 +49,7 @@ View< L, V, O >::View( L* layout )
     , _capabilities( LB_BIT_ALL_64 )
     , _equalizers( EQUALIZER_ALL )
     , _modelUnit( EQ_M )
+    , _screenshotBuffers( Frame::Buffer::none )
 {
     // Note: Views are an exception to the strong structuring, since render
     // client views are multi-buffered (once per pipe) and do not have a parent
@@ -98,6 +99,8 @@ void View< L, V, O >::serialize( co::DataOStream& os, const uint64_t dirtyBits )
         os << _modelUnit;
     if( dirtyBits & DIRTY_ATTRIBUTES )
         os << co::Array< std::string >( _sAttributes, SATTR_ALL );
+    if( dirtyBits & DIRTY_SCREENSHOT )
+        os << _screenshotBuffers;
 }
 
 template< class L, class V, class O >
@@ -168,6 +171,8 @@ void View< L, V, O >::deserialize( co::DataIStream& is,
         is >> _modelUnit;
     if( dirtyBits & DIRTY_ATTRIBUTES )
         is >> co::Array< std::string >( _sAttributes, SATTR_ALL );
+    if( dirtyBits & DIRTY_SCREENSHOT )
+        is >> _screenshotBuffers;
 }
 
 template< class L, class V, class O >
@@ -364,6 +369,22 @@ uint64_t View< L, V, O >::getCapabilities() const
     return _capabilities;
 }
 
+template< class L, class V, class O >
+void View< L, V, O >::_setScreenshotBuffers( const Frame::Buffer buffers )
+{
+    if( _screenshotBuffers == buffers )
+        return;
+
+    _screenshotBuffers = buffers;
+    setDirty( DIRTY_SCREENSHOT );
+}
+
+template< class L, class V, class O >
+Frame::Buffer View< L, V, O >::getScreenshotBuffers() const
+{
+    return _screenshotBuffers;
+}
+
 template< class L, class V, class O >
 const std::string& View< L, V, O >::getSAttribute( const SAttribute attr ) const
 {