Source/System/Cluster/Window/SortLast/OSGPipelineComposer.h

   1 /*---------------------------------------------------------------------------*\
   2  *                                OpenSG                                     *
   3  *                                                                           *
   4  *                                                                           *
   5  *               Copyright (C) 2000-2002 by the OpenSG Forum                 *
   6  *                                                                           *
   7  *                            www.opensg.org                                 *
   8  *                                                                           *
   9  *   contact: dirk@opensg.org, gerrit.voss@vossg.org, jbehr@zgdv.de          *
  10  *                                                                           *
  11 \*---------------------------------------------------------------------------*/
  12 /*---------------------------------------------------------------------------*\
  13  *                                License                                    *
  14  *                                                                           *
  15  * This library is free software; you can redistribute it and/or modify it   *
  16  * under the terms of the GNU Library General Public License as published    *
  17  * by the Free Software Foundation, version 2.                               *
  18  *                                                                           *
  19  * This library is distributed in the hope that it will be useful, but       *
  20  * WITHOUT ANY WARRANTY; without even the implied warranty of                *
  21  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU         *
  22  * Library General Public License for more details.                          *
  23  *                                                                           *
  24  * You should have received a copy of the GNU Library General Public         *
  25  * License along with this library; if not, write to the Free Software       *
  26  * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.                 *
  27  *                                                                           *
  28 \*---------------------------------------------------------------------------*/
  29 /*---------------------------------------------------------------------------*\
  30  *                                Changes                                    *
  31  *                                                                           *
  32  *                                                                           *
  33  *                                                                           *
  34  *                                                                           *
  35  *                                                                           *
  36  *                                                                           *
  37 \*---------------------------------------------------------------------------*/
  38
  39 #ifndef _OSGPIPELINECOMPOSER_H_
  40 #define _OSGPIPELINECOMPOSER_H_
  41 #ifdef __sgi
  42 #pragma once
  43 #endif
  44
  45 #include "OSGGL.h"
  46 #include "OSGGLU.h"
  47 #include "OSGPipelineComposerBase.h"
  48 #include "OSGBaseThread.h"
  49 #include "OSGLock.h"
  50 #include "OSGClusterNetwork.h"
  51
  52 //#define COMPRESS_IMAGES 1
  53
  54 #ifdef COMPRESS_IMAGES
  55 #include <lzf.h>
  56 #include <lzf_c.cpp>
  57 #include <lzf_d.cpp>
  58 #endif
  59
  60 OSG_BEGIN_NAMESPACE
  61
  62 //#define USE_NV_OCCLUSION 1
  63
  64 /*! \brief PipelineComposer class. See \ref
  65            PageSystemPipelineComposer for a description.
  66
  67     \ingroup GrpClusterWindowComposer
  68     \ingroup GrpLibOSGCluster
  69     \includebasedoc
  70  */
  71
  72 class OSG_CLUSTER_DLLMAPPING PipelineComposer : public PipelineComposerBase
  73 {
  74   private:
  75
  76     typedef PipelineComposerBase       Inherited;
  77
  78     struct TileBuffer;
  79     struct GroupInfo;
  80     struct GroupInfoOrder;
  81
  82     friend struct TileBuffer;
  83     friend struct GroupInfo;
  84     friend struct GroupInfoOrder;
  85
  86     /*! \brief RGB Color value
  87         \nohierarchy
  88      */
  89
  90     struct RGBValue
  91     {
  92         UInt8 red;
  93         UInt8 green;
  94         UInt8 blue;
  95     };
  96
  97     /*! \nohierarchy
  98      */
  99
 100     struct DepthInfo
 101     {
 102         UInt32 min;
 103         UInt32 max;
 104         UInt8  occlude;
 105     };
 106
 107     /*! \nohierarchy
 108      */
 109
 110     struct TransInfo
 111     {
 112         unsigned int sendTo   :13;
 113         unsigned int empty    :1;
 114         unsigned int sendDepth:1;
 115         unsigned int first    :1;
 116     };
 117
 118     /*! \nohierarchy
 119      */
 120
 121     struct TileBuffer
 122     {
 123         bool empty;
 124         UInt32 size;
 125         UInt32 colorSize;
 126         UInt32 depthSize;
 127         UInt32 dataSize;
 128         Connection *dstConnection;
 129         struct DepthInfo depth;
 130         struct TransInfo trans;
 131
 132         /*! \nohierarchy
 133          */
 134
 135         struct
 136         {
 137             UInt32 count;
 138             UInt16 x;
 139             UInt16 y;
 140             UInt16 w;
 141             UInt16 h;
 142             UInt16 depth;
 143         } header;
 144         UInt8 data[1];
 145     };
 146
 147     /*! \nohierarchy
 148      */
 149
 150     struct GroupInfo
 151     {
 152         UInt32 id;
 153         struct DepthInfo depth;
 154         struct TransInfo trans;
 155     };
 156
 157     /*! \nohierarchy
 158      */
 159
 160     struct GroupInfoOrder : public std::binary_function<
 161         const GroupInfo*,const GroupInfo*, bool>
 162     {
 163         bool operator() (const GroupInfo *a, const GroupInfo *b);
 164     };
 165
 166     /*! \nohierarchy
 167      */
 168
 169     struct Statistics
 170     {
 171         UInt32 bytesIn;
 172         UInt32 bytesOut;
 173         UInt32 occluded;
 174         UInt32 noDepth;
 175         UInt32 noGeo;
 176         UInt32 clipped;
 177         double sortTime;
 178         double pixelReadTime;
 179         double composeTime;
 180     };
 181
 182     typedef std::list<TileBuffer*> QueueT;
 183
 184     /*==========================  PUBLIC  =================================*/
 185
 186   public:
 187
 188     /*---------------------------------------------------------------------*/
 189     /*! \name                      Sync                                    */
 190     /*! \{                                                                 */
 191
 192     virtual void changed(ConstFieldMaskArg whichField,
 193                          UInt32            origin,
 194                          BitVector         detail);
 195
 196     /*! \}                                                                 */
 197     /*---------------------------------------------------------------------*/
 198     /*! \name                     Output                                   */
 199     /*! \{                                                                 */
 200
 201     virtual void dump(      UInt32     uiIndent = 0,
 202                       const BitVector  bvFlags  = 0) const;
 203
 204     /*! \}                                                                 */
 205     /*---------------------------------------------------------------------*/
 206     /*! \name      composition                                             */
 207     /*! \{                                                                 */
 208
 209     virtual void open           (void          );
 210     virtual void startViewport  (Viewport *port);
 211     virtual void composeViewport(Viewport *port);
 212     virtual void close          (void          );
 213
 214     /*! \}                                                                 */
 215     /*---------------------------------------------------------------------*/
 216     /*! \name      features                                                */
 217     /*! \{                                                                 */
 218
 219     virtual bool getClientRendering(void);
 220
 221     /*! \}                                                                 */
 222     /*=========================  PROTECTED  ===============================*/
 223
 224   protected:
 225
 226     UInt32                      _tileBufferSize;
 227     std::vector<UInt8>          _tileA;
 228     std::vector<UInt8>          _tileB;
 229     std::vector<UInt8>          _workingTile;
 230     std::vector<UInt8>         *_readTilePtr;
 231     std::vector<UInt8>         *_composeTilePtr;
 232     UInt32                      _readTilesX;
 233     UInt32                      _readTilesY;
 234     UInt32                      _composeTilesX;
 235     UInt32                      _composeTilesY;
 236
 237     std::vector< TransInfo              > _transInfo;
 238     std::list  < GroupInfo              > _groupInfoPool;
 239     std::vector< GroupInfo*             > _groupInfo;
 240
 241     GLenum                      _colorFormat;
 242     GLenum                      _colorType;
 243     GLenum                      _depthType;
 244
 245     Statistics                  _statistics;
 246
 247     BaseThreadRefPtr            _writer;
 248     ThreadRefPtr                _composer;
 249     BarrierRefPtr               _barrier;
 250     BarrierRefPtr               _composeBarrier;
 251     BarrierRefPtr               _frameEndBarrier;
 252     LockRefPtr                  _lock;
 253     QueueT                      _queue;
 254     bool                        _waiting;
 255     GLuint                      _occlusionQuery;
 256     bool                        _firstFrame;
 257
 258     /*---------------------------------------------------------------------*/
 259     /*! \name                  Constructors                                */
 260     /*! \{                                                                 */
 261
 262     PipelineComposer(void);
 263     PipelineComposer(const PipelineComposer &source);
 264
 265     /*! \}                                                                 */
 266     /*---------------------------------------------------------------------*/
 267     /*! \name                   Destructors                                */
 268     /*! \{                                                                 */
 269
 270     virtual ~PipelineComposer(void);
 271
 272     /*! \}                                                                 */
 273     /*---------------------------------------------------------------------*/
 274     /*! \name                      helper function                         */
 275     /*! \{                                                                 */
 276
 277     template<class DepthT,class ColorT>
 278     UInt32 getMinMaxOcclude(DepthT &depth,ColorT &color,
 279                             DepthInfo *buffer);
 280
 281     template<class DepthT,class ColorT>
 282     void setTransInfo(DepthT &depth,ColorT &color);
 283
 284     template<class DepthT,class ColorT>
 285     void calculateTransInfo(DepthT &depth,ColorT &color);
 286
 287     template<class DepthT,class ColorT>
 288     void clientCompose(DepthT &depth,ColorT &color);
 289
 290     template<class DepthT,class ColorT>
 291     void serverCompose(DepthT &depth,ColorT &color);
 292
 293     template<class DepthT,class ColorT>
 294     void writeResult(DepthT &depth,ColorT &color);
 295
 296     template<class DepthT,class ColorT>
 297     void readBuffer(DepthT &depth,ColorT &color,
 298                     Viewport *port);
 299     template<class DepthT,class ColorT>
 300     void composeBuffer(DepthT &depth,ColorT &color);
 301
 302     UInt32 compressTransInfo(std::vector<TransInfo> &transInfo);
 303     void   uncompressTransInfo(std::vector<TransInfo> &transInfo,
 304                                UInt32 infoCount);
 305
 306     template <class T,T empty>
 307     static bool checkDepth(T *buffer,T &front,T &back,int size);
 308
 309     TileBuffer *getComposeTileBuffer(UInt32 x,UInt32 y);
 310     TileBuffer *getReadTileBuffer(UInt32 x,UInt32 y);
 311     TileBuffer *getWorkingTileBuffer(void);
 312
 313     /*! \}                                                                 */
 314     /*---------------------------------------------------------------------*/
 315     /*! \name                       Init                                   */
 316     /*! \{                                                                 */
 317
 318     static void initMethod(InitPhase ePhase);
 319
 320     /*! \}                                                                 */
 321     /*==========================  PRIVATE  ================================*/
 322   private:
 323
 324     friend class FieldContainer;
 325     friend class PipelineComposerBase;
 326
 327     static void writeProc(void *arg);
 328     static void composeProc(void *arg);
 329
 330     // prohibit default functions (move to 'public' if you need one)
 331     void operator =(const PipelineComposer &source);
 332 };
 333
 334 typedef PipelineComposer *PipelineComposerP;
 335
 336 OSG_END_NAMESPACE
 337
 338 #include "OSGPipelineComposerBase.inl"
 339 #include "OSGPipelineComposer.inl"
 340
 341 #endif /* _OSGPIPELINECOMPOSER_H_ */