CR #153

Author: Stefan Eilemann

deflect/ReceiveBuffer.h

@@ -65,8 +65,8 @@ class ReceiveBuffer
      * Add a source of segments.
      * @param sourceIndex Unique source identifier
      * @return false if the source was already added or if
-     * finishFrameForSource()
-     *         has already been called for all existing source (TODO DISCL-241).
+     *         finishFrameForSource() has already been called for all existing
+     *         source (TODO DISCL-241).
      */
     DEFLECT_API bool addSource(size_t sourceIndex);
 

deflect/Stream.h

@@ -127,7 +127,7 @@ class Stream
      * @param image The image to send. Note that the image is not copied, so the
      *              referenced must remain valid until the send is finished.
      * @return true if the image data could be sent, false otherwise
-     * @version 1.0
+     * @version 1.6
      * @sa finishFrame()
      */
     DEFLECT_API Future send(const ImageWrapper& image);
@@ -142,7 +142,7 @@ class Stream
      * stereo rendering.
      *
      * @sa send()
-     * @version 1.0
+     * @version 1.6
      */
     DEFLECT_API Future finishFrame();
 
@@ -157,7 +157,7 @@ class Stream
      *              referenced must remain valid until the send is finished
      * @return true if the image data could be sent, false otherwise.
      * @see send()
-     * @version 1.1
+     * @version 1.6
      */
     DEFLECT_API Future sendAndFinish(const ImageWrapper& image);
 

doc/Changelog.md

@@ -10,9 +10,8 @@ Changelog {#Changelog}
   skipping the YUV -> RGB conversion step.
   Additionally, Stream images can be further compressed using optional
   [chroma subsampling](ChromaSubsampling.md).
-* [152](https://github.com/BlueBrain/Deflect/pull/152):
-  Changed coding style of the project to conform to new .clang-format rules.
-* [148](https://github.com/BlueBrain/Deflect/pull/148):
+* [148](https://github.com/BlueBrain/Deflect/pull/148),
+  [153](https://github.com/BlueBrain/Deflect/pull/153):
   Support for streaming stereo 3D content in a frame-sequential manner.
 
 ## Deflect 0.12

doc/StereoStreaming.md

@@ -21,7 +21,7 @@ New view enum in deflect/types.h:
 The ImageWrapper takes an additional View parameter.
 
 API changes to the Stream class:
-* asyncSend is deprecated but work as before, but only for mono views
+* asyncSend is renamed to sendAndFinish, asyncSend forwards and is deprecated
 * send and finish are now asynchronous and return a future instead of bool
 
 The send operation sends one tile of one eye pass to the server. The finishFrame
@@ -31,8 +31,8 @@ finishFrame is analogous to a swap buffer call, with the extension that all
 client's finish is synchronized by the server.
 
 On the server side, no changes to the Server API (except some cleanups). Each
-Frame dispatched now contains the View information. A frame is considered
-complete when all connected clients did send a finish.
+Segment dispatched now with a Frame contains the View information. A frame is
+considered complete when all connected clients have send a finish.
 
 
 ## Protocol
@@ -54,15 +54,15 @@ Example of a stereo 3D client application using synchronous operations:
 
     deflect::ImageWrapper leftImage( data, width, height, deflect::RGBA );
     leftImage.view = deflect::View::left_eye;
-    deflectStream->send( leftImage );
+    deflectStream->send( leftImage ).wait();
 
     /** ...render right image... */
 
     deflect::ImageWrapper rightImage( data, width, height, deflect::RGBA );
     rightImage.view = deflect::View::right_eye;
-    deflectStream->send( rightImage );
+    deflectStream->send( rightImage ).wait();
 
-    deflectStream->finishFrame();
+    deflectStream->finishFrame().wait();
 
     /** ...synchronize with other render clients (network barrier)... */
     }
@@ -72,25 +72,27 @@ Example of a stereo 3D client application using the asynchronous operations:
     deflect::Stream stream( ... );
 
     /** ...synchronize start with other render clients (network barrier)... */
-
+    std::vector< std::future< bool >> futures;
     renderLoop()
     {
-    if( !leftFuture.valid() || !leftFuture.get( ))
-       return;
+    for( auto& future : futures )
+        if( !future.get( ))
+            return;
+    futures.clear();
 
     /** ...render left image... */
 
     deflect::ImageWrapper leftImage( leftData, width, height, deflect::RGBA );
     leftImage.view = deflect::View::left_eye;
-    auto leftFuture = deflectStream->send( leftImage );
+    futures.emplace_back( deflectStream->send( leftImage ));
 
     /** ...render right image... */
 
     deflect::ImageWrapper rightImage( rightData, width, height, deflect::RGBA );
     rightImage.view = deflect::View::right_eye;
-    auto rightFuture = deflectStream->send( rightImage );
+    futures.emplace_back( deflectStream->send( rightImage ));
 
-    deflectStream->finishFrame();
+    futures.emplace_back( deflectStream->finishFrame( ));
 
     /** ...synchronize with other render clients (network barrier)... */
     }

tests/cpp/perf/benchmarkStreamer.cpp

@@ -241,8 +241,7 @@ class Application
                                            _noiseImage.height(), deflect::RGBA);
         deflectImage.compressionPolicy = deflect::COMPRESSION_OFF;
 
-        return _stream->send(deflectImage).get() &&
-               _stream->finishFrame().get();
+        return _stream->sendAndFinish(deflectImage).get();
     }
 
     bool sendJpeg()
@@ -253,8 +252,7 @@ class Application
         deflectImage.compressionPolicy = deflect::COMPRESSION_ON;
         deflectImage.compressionQuality = _options.quality;
 
-        return _stream->send(deflectImage).get() &&
-               _stream->finishFrame().get();
+        return _stream->sendAndFinish(deflectImage).get();
     }
 
     bool sendPrecompressedJpeg()