0030144: Visualization, TKOpenGl - extend OpenGl_FrameStats with frame timers
[occt.git] / src / OpenGl / OpenGl_FrameStatsPrs.cxx
1 // Copyright (c) 2017 OPEN CASCADE SAS
2 //
3 // This file is part of Open CASCADE Technology software library.
4 //
5 // This library is free software; you can redistribute it and/or modify it under
6 // the terms of the GNU Lesser General Public License version 2.1 as published
7 // by the Free Software Foundation, with special exception defined in the file
8 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
9 // distribution for complete text of the license and disclaimer of any warranty.
10 //
11 // Alternatively, this file may be used under the terms of Open CASCADE
12 // commercial license or contractual agreement.
13
14 #include <OpenGl_FrameStatsPrs.hxx>
15
16 #include <OpenGl_View.hxx>
17 #include <OpenGl_ShaderManager.hxx>
18 #include <OpenGl_Workspace.hxx>
19
20 #include <Graphic3d_ArrayOfTriangles.hxx>
21
22 namespace
23 {
24   //! Auxiliary structure defining vertex with two attributes.
25   struct OpenGl_Vec3Vec4ub
26   {
27     Graphic3d_Vec3   Pos;
28     Graphic3d_Vec4ub Color;
29   };
30
31   //! Auxiliary function formatting rendering time in " 10 ms (100 FPS)" format.
32   static TCollection_AsciiString formatTimeMs (Standard_Real theSeconds)
33   {
34     const Standard_Real aFpsVal = theSeconds != 0.0 ? 1.0 / theSeconds : 0.0;
35     char aFps[50];
36     Sprintf (aFps, "%.1f", aFpsVal);
37     return TCollection_AsciiString() + Standard_Integer(theSeconds * 1000.0) + " ms (" + aFps + " FPS)";
38   }
39 }
40
41 // =======================================================================
42 // function : OpenGl_FrameStatsPrs
43 // purpose  :
44 // =======================================================================
45 OpenGl_FrameStatsPrs::OpenGl_FrameStatsPrs()
46 : myStatsPrev (new OpenGl_FrameStats()),
47   myCountersTrsfPers (new Graphic3d_TransformPers (Graphic3d_TMF_2d, Aspect_TOTP_LEFT_UPPER,  Graphic3d_Vec2i (20, 20))),
48   myChartTrsfPers    (new Graphic3d_TransformPers (Graphic3d_TMF_2d, Aspect_TOTP_RIGHT_UPPER, Graphic3d_Vec2i (20, 20))),
49   myChartVertices (new OpenGl_VertexBuffer()),
50   myChartIndices (new OpenGl_IndexBuffer()),
51   myChartLines (new OpenGl_VertexBuffer())
52 {
53   //
54 }
55
56 // =======================================================================
57 // function : ~OpenGl_FrameStatsPrs
58 // purpose  :
59 // =======================================================================
60 OpenGl_FrameStatsPrs::~OpenGl_FrameStatsPrs()
61 {
62   //
63 }
64
65 // =======================================================================
66 // function : Release
67 // purpose  :
68 // =======================================================================
69 void OpenGl_FrameStatsPrs::Release (OpenGl_Context* theCtx)
70 {
71   myCountersText.Release (theCtx);
72   myChartLabels[0].Release (theCtx);
73   myChartLabels[1].Release (theCtx);
74   myChartLabels[2].Release (theCtx);
75   myChartVertices->Release (theCtx);
76   myChartIndices->Release (theCtx);
77   myChartLines->Release (theCtx);
78 }
79
80 // =======================================================================
81 // function : Update
82 // purpose  :
83 // =======================================================================
84 void OpenGl_FrameStatsPrs::Update (const Handle(OpenGl_Workspace)& theWorkspace)
85 {
86   const Handle(OpenGl_Context)& aCtx = theWorkspace->GetGlContext();
87   const Handle(OpenGl_FrameStats)& aStats = aCtx->FrameStats();
88   const Graphic3d_RenderingParams& aRendParams = theWorkspace->View()->RenderingParams();
89   myCountersTrsfPers = theWorkspace->View()->RenderingParams().StatsPosition;
90   myChartTrsfPers    = theWorkspace->View()->RenderingParams().ChartPosition;
91   myTextAspect.SetAspect (aRendParams.StatsTextAspect);
92
93   // adjust text alignment depending on corner
94   OpenGl_TextParam aParams;
95   aParams.Height = aRendParams.StatsTextHeight;
96   aParams.HAlign = Graphic3d_HTA_CENTER;
97   aParams.VAlign = Graphic3d_VTA_CENTER;
98   if (!myCountersTrsfPers.IsNull() && (myCountersTrsfPers->Corner2d() & Aspect_TOTP_LEFT) != 0)
99   {
100     aParams.HAlign = Graphic3d_HTA_LEFT;
101   }
102   else if (!myCountersTrsfPers.IsNull() && (myCountersTrsfPers->Corner2d() & Aspect_TOTP_RIGHT) != 0)
103   {
104     aParams.HAlign = Graphic3d_HTA_RIGHT;
105   }
106   if (!myCountersTrsfPers.IsNull() && (myCountersTrsfPers->Corner2d() & Aspect_TOTP_TOP) != 0)
107   {
108     aParams.VAlign = Graphic3d_VTA_TOP;
109   }
110   else if (!myCountersTrsfPers.IsNull() && (myCountersTrsfPers->Corner2d() & Aspect_TOTP_BOTTOM) != 0)
111   {
112     aParams.VAlign = Graphic3d_VTA_BOTTOM;
113   }
114   if (aParams.Height != myCountersText.FormatParams().Height
115    || aParams.HAlign != myCountersText.FormatParams().HAlign
116    || aParams.VAlign != myCountersText.FormatParams().VAlign)
117   {
118     myCountersText.Release (aCtx.operator->());
119   }
120
121   if (!aStats->IsFrameUpdated (myStatsPrev)
122    && !myCountersText.Text().IsEmpty())
123   {
124     return;
125   }
126
127   TCollection_AsciiString aText = aStats->FormatStats (aRendParams.CollectedStats);
128   myCountersText.Init (aCtx, aText.ToCString(), OpenGl_Vec3 (0.0f, 0.0f, 0.0f), aParams);
129
130   updateChart (theWorkspace);
131 }
132
133 // =======================================================================
134 // function : updateChart
135 // purpose  :
136 // =======================================================================
137 void OpenGl_FrameStatsPrs::updateChart (const Handle(OpenGl_Workspace)& theWorkspace)
138 {
139   const Handle(OpenGl_Context)& aCtx = theWorkspace->GetGlContext();
140   const Handle(OpenGl_FrameStats)& aStats = aCtx->FrameStats();
141   const Graphic3d_RenderingParams& aRendParams = theWorkspace->View()->RenderingParams();
142
143   const Standard_Integer aNbBins = aStats->DataFrames().Size();
144   if (aNbBins <= 1)
145   {
146     return;
147   }
148
149   Standard_Real aMaxDuration = aRendParams.StatsMaxChartTime;
150   if (aMaxDuration <= 0.0f)
151   {
152     for (Standard_Integer aFrameIter = aStats->DataFrames().Lower(); aFrameIter <= aStats->DataFrames().Upper(); ++aFrameIter)
153     {
154       const Graphic3d_FrameStatsData& aFrame = aStats->DataFrames().Value (aFrameIter);
155       aMaxDuration = Max (aMaxDuration, aFrame.TimerValue (Graphic3d_FrameStatsTimer_ElapsedFrame));
156     }
157     aMaxDuration = Ceiling (aMaxDuration * 1000.0 * 0.1) * 0.001 * 10.0; // round number
158     aMaxDuration = Max (Min (aMaxDuration, 0.1), 0.005); // limit by 100 ms (10 FPS) and 5 ms (200 FPS)
159   }
160
161   const Standard_Integer aNbTimers = 4;
162   const Graphic3d_FrameStatsTimer aTimers[4] =
163   {
164     Graphic3d_FrameStatsTimer_CpuDynamics,
165     Graphic3d_FrameStatsTimer_CpuPicking,
166     Graphic3d_FrameStatsTimer_CpuCulling,
167     Graphic3d_FrameStatsTimer_ElapsedFrame,
168   };
169   const Graphic3d_Vec4ub aColors[4] =
170   {
171     Graphic3d_Vec4ub (255, 0, 0, 127),
172     Graphic3d_Vec4ub (255, 127, 39, 127),
173     Graphic3d_Vec4ub (255, 0, 0, 127),
174     Graphic3d_Vec4ub (0, 255, 0, 127),
175   };
176
177   const Standard_Integer aNbVerts   = aNbBins * 4 * aNbTimers;
178   const Standard_Integer aNbIndexes = aNbBins * 2 * 3 * aNbTimers;
179   bool toFillEdges = false;
180   if (myChartArray.IsNull()
181    || myChartArray->VertexNumber() != aNbVerts
182    || myChartArray->EdgeNumber()   != aNbIndexes)
183   {
184     myChartArray = new Graphic3d_ArrayOfTriangles (aNbVerts, aNbIndexes, false, true);
185     toFillEdges = true;
186   }
187
188   const Graphic3d_Vec2i aViewSize (aCtx->VirtualViewport()[2], aCtx->VirtualViewport()[3]);
189   Graphic3d_Vec2i aCharSize (aRendParams.ChartSize);
190   if (aCharSize.x() <= 0)
191   {
192     aCharSize.x() = aViewSize.x() / 2;
193   }
194   if (aCharSize.y() <= 0)
195   {
196     aCharSize.y() = Standard_Integer(0.15 * aViewSize.y());
197   }
198
199   const Graphic3d_Vec2d aBinSize  (Standard_Real(aCharSize.x()) / Standard_Real(aNbBins), 0.15 * aViewSize.y());
200   Graphic3d_Vec2i anOffset;
201   if (!myChartTrsfPers.IsNull()
202     && myChartTrsfPers->IsTrihedronOr2d())
203   {
204     if ((myChartTrsfPers->Corner2d() & Aspect_TOTP_LEFT) != 0)
205     {
206       anOffset.x() = 0;
207     }
208     else if ((myChartTrsfPers->Corner2d() & Aspect_TOTP_RIGHT) != 0)
209     {
210       anOffset.x() = -aCharSize.x();
211     }
212     else
213     {
214       anOffset.x() = -aCharSize.x() / 2;
215     }
216
217     if ((myChartTrsfPers->Corner2d() & Aspect_TOTP_BOTTOM) != 0)
218     {
219       anOffset.y() = aCharSize.y();
220     }
221     else if ((myChartTrsfPers->Corner2d() & Aspect_TOTP_TOP) != 0)
222     {
223       anOffset.y() = 0;
224     }
225     else
226     {
227       anOffset.y() = aCharSize.y() / 2;
228     }
229   }
230
231   Standard_Integer aVertLast = 1;
232   const bool isTopDown = false;
233   for (Standard_Integer aFrameIter = 0; aFrameIter < aNbBins; ++aFrameIter)
234   {
235     Standard_Integer aFrameIndex = aStats->DataFrames().Lower() + aStats->LastDataFrameIndex() + 1 + aFrameIter;
236     if (aFrameIndex > aStats->DataFrames().Upper())
237     {
238       aFrameIndex -= aNbBins;
239     }
240
241     const Graphic3d_FrameStatsData& aFrame = aStats->DataFrames().Value (aFrameIndex);
242     Standard_Real aTimeElapsed = 0.0;
243     Standard_Real aCurrY = 0.0;
244     for (Standard_Integer aTimerIter = 0; aTimerIter < aNbTimers; ++aTimerIter)
245     {
246       if (aTimers[aTimerIter] == Graphic3d_FrameStatsTimer_ElapsedFrame)
247       {
248         aTimeElapsed = aFrame.TimerValue (aTimers[aTimerIter]);
249       }
250       else
251       {
252         aTimeElapsed += aFrame.TimerValue (aTimers[aTimerIter]);
253       }
254
255       const Standard_Real aBinX1 = anOffset.x() + Standard_Real(aFrameIter) * aBinSize.x();
256       const Standard_Real aBinX2 = aBinX1 + aBinSize.x();
257       const Standard_Real aCurrSizeY = Min (aTimeElapsed / aMaxDuration, 1.2) * aBinSize.y();
258       const Standard_Real aBinY1 = isTopDown ? (anOffset.y() - aCurrY)     : (anOffset.y() - aBinSize.y() + aCurrY);
259       const Standard_Real aBinY2 = isTopDown ? (anOffset.y() - aCurrSizeY) : (anOffset.y() - aBinSize.y() + aCurrSizeY);
260       myChartArray->SetVertice (aVertLast + 0, gp_Pnt (aBinX1, aBinY2, 0.0));
261       myChartArray->SetVertice (aVertLast + 1, gp_Pnt (aBinX1, aBinY1, 0.0));
262       myChartArray->SetVertice (aVertLast + 2, gp_Pnt (aBinX2, aBinY1, 0.0));
263       myChartArray->SetVertice (aVertLast + 3, gp_Pnt (aBinX2, aBinY2, 0.0));
264
265       if (toFillEdges)
266       {
267         const Graphic3d_Vec4ub& aTimerColor = aColors[aTimerIter];
268         myChartArray->SetVertexColor (aVertLast + 0, aTimerColor);
269         myChartArray->SetVertexColor (aVertLast + 1, aTimerColor);
270         myChartArray->SetVertexColor (aVertLast + 2, aTimerColor);
271         myChartArray->SetVertexColor (aVertLast + 3, aTimerColor);
272         myChartArray->AddEdges (aVertLast + 0, aVertLast + 1, aVertLast + 3);
273         myChartArray->AddEdges (aVertLast + 1, aVertLast + 2, aVertLast + 3);
274       }
275       aVertLast += 4;
276
277       if (aTimers[aTimerIter] == Graphic3d_FrameStatsTimer_ElapsedFrame)
278       {
279         aTimeElapsed = 0.0;
280         aCurrY = 0.0;
281       }
282       else
283       {
284         aCurrY = aCurrSizeY;
285       }
286     }
287   }
288
289   myChartVertices->init (aCtx,
290                          myChartArray->Attributes()->Stride,
291                          myChartArray->Attributes()->NbElements,
292                          myChartArray->Attributes()->Data(),
293                          GL_UNSIGNED_BYTE,
294                          myChartArray->Attributes()->Stride);
295   if (myChartArray->Indices()->Stride == 2)
296   {
297     myChartIndices ->Init (aCtx,
298                            1,
299                            myChartArray->Indices()->NbElements,
300                            (const GLushort* )myChartArray->Indices()->Data());
301   }
302   else if (myChartArray->Indices()->Stride == 4)
303   {
304     myChartIndices ->Init (aCtx,
305                            1,
306                            myChartArray->Indices()->NbElements,
307                            (const GLuint* )myChartArray->Indices()->Data());
308   }
309
310   {
311     const Graphic3d_Vec4ub aWhite (255, 255, 255, 255);
312     const OpenGl_Vec3Vec4ub aLines[4] =
313     {
314       { Graphic3d_Vec3((float )anOffset.x(), (float )anOffset.y(),                0.0f), aWhite },
315       { Graphic3d_Vec3(float(anOffset.x() + aCharSize.x()), (float )anOffset.y(), 0.0f), aWhite },
316       { Graphic3d_Vec3((float )anOffset.x(), float(anOffset.y() - aBinSize.y()),  0.0f), aWhite },
317       { Graphic3d_Vec3(float(anOffset.x() + aCharSize.x()), float(anOffset.y() - aBinSize.y()),+ 0.0f), aWhite },
318     };
319     myChartLines->init (aCtx, sizeof(OpenGl_Vec3Vec4ub), 4, aLines, GL_UNSIGNED_BYTE, sizeof(OpenGl_Vec3Vec4ub));
320   }
321
322   {
323     OpenGl_TextParam aParams;
324     aParams.Height = aRendParams.StatsTextHeight;
325     aParams.HAlign = (!myChartTrsfPers.IsNull()
326                     && myChartTrsfPers->IsTrihedronOr2d()
327                     && (myChartTrsfPers->Corner2d() & Aspect_TOTP_RIGHT) != 0)
328                     ? Graphic3d_HTA_RIGHT
329                     : Graphic3d_HTA_LEFT;
330     aParams.VAlign = Graphic3d_VTA_CENTER;
331     TCollection_AsciiString aLabels[3] =
332     {
333       TCollection_AsciiString() + 0 + " ms",
334       formatTimeMs(aMaxDuration * 0.5),
335       formatTimeMs(aMaxDuration)
336     };
337
338     const float aLabX = aParams.HAlign == Graphic3d_HTA_RIGHT
339                       ? float(anOffset.x())
340                       : float(anOffset.x() + aCharSize.x());
341     myChartLabels[0].Init (aCtx, aLabels[isTopDown ? 0 : 2].ToCString(), OpenGl_Vec3 (aLabX, float(anOffset.y()),                    0.0f), aParams);
342     myChartLabels[1].Init (aCtx, aLabels[isTopDown ? 1 : 1].ToCString(), OpenGl_Vec3 (aLabX, float(anOffset.y() - aBinSize.y() / 2), 0.0f), aParams);
343     myChartLabels[2].Init (aCtx, aLabels[isTopDown ? 2 : 0].ToCString(), OpenGl_Vec3 (aLabX, float(anOffset.y() - aBinSize.y()),     0.0f), aParams);
344   }
345 }
346
347 // =======================================================================
348 // function : Render
349 // purpose  :
350 // =======================================================================
351 void OpenGl_FrameStatsPrs::Render (const Handle(OpenGl_Workspace)& theWorkspace) const
352 {
353   const Handle(OpenGl_Context)& aCtx = theWorkspace->GetGlContext();
354   const Standard_Boolean wasEnabledDepth = theWorkspace->UseDepthWrite();
355   if (theWorkspace->UseDepthWrite())
356   {
357     theWorkspace->UseDepthWrite() = Standard_False;
358     glDepthMask (GL_FALSE);
359   }
360
361   const OpenGl_AspectText* aTextAspectBack = theWorkspace->SetAspectText (&myTextAspect);
362
363   aCtx->ModelWorldState.Push();
364   aCtx->ModelWorldState.ChangeCurrent().InitIdentity();
365
366   // draw counters
367   {
368     aCtx->WorldViewState.Push();
369     if (!myCountersTrsfPers.IsNull())
370     {
371       myCountersTrsfPers->Apply (theWorkspace->View()->Camera(),
372                                  aCtx->ProjectionState.Current(), aCtx->WorldViewState.ChangeCurrent(),
373                                  aCtx->VirtualViewport()[2], aCtx->VirtualViewport()[3]);
374     }
375     aCtx->ApplyModelViewMatrix();
376     myCountersText.Render (theWorkspace);
377     aCtx->WorldViewState.Pop();
378   }
379
380   // draw chart
381   if (myChartIndices->IsValid()
382    && myChartIndices->GetElemsNb() > 0)
383   {
384     aCtx->WorldViewState.Push();
385     if (!myChartTrsfPers.IsNull())
386     {
387       myChartTrsfPers->Apply (theWorkspace->View()->Camera(),
388                               aCtx->ProjectionState.Current(), aCtx->WorldViewState.ChangeCurrent(),
389                               aCtx->VirtualViewport()[2], aCtx->VirtualViewport()[3]);
390     }
391     aCtx->ApplyModelViewMatrix();
392
393     aCtx->ShaderManager()->BindFaceProgram (Handle(OpenGl_TextureSet)(), Graphic3d_TOSM_UNLIT,
394                                             Graphic3d_AlphaMode_Blend, true, false,
395                                             Handle(OpenGl_ShaderProgram)());
396     aCtx->SetColor4fv (OpenGl_Vec4 (1.0f, 1.0f, 1.0f, 1.0f));
397     glEnable (GL_BLEND);
398     glBlendFunc (GL_SRC_ALPHA, GL_ONE_MINUS_SRC_ALPHA);
399     myChartVertices->Bind (aCtx);
400     myChartVertices->bindAttribute (aCtx, Graphic3d_TOA_POS,   3, GL_FLOAT,         myChartVertices->GetComponentsNb(), NULL);
401     myChartVertices->bindAttribute (aCtx, Graphic3d_TOA_COLOR, 4, GL_UNSIGNED_BYTE, myChartVertices->GetComponentsNb(), (void* )sizeof(Graphic3d_Vec3));
402
403     myChartIndices->Bind (aCtx);
404     aCtx->core15fwd->glDrawElements (GL_TRIANGLES, myChartIndices->GetElemsNb(), myChartIndices->GetDataType(), NULL);
405     myChartIndices->Unbind (aCtx);
406     myChartVertices->Unbind (aCtx);
407     myChartVertices->unbindAttribute (aCtx, Graphic3d_TOA_COLOR);
408     myChartVertices->unbindAttribute (aCtx, Graphic3d_TOA_POS);
409     glDisable (GL_BLEND);
410
411     myChartLines->Bind (aCtx);
412     myChartLines->bindAttribute (aCtx, Graphic3d_TOA_POS,   3, GL_FLOAT,         myChartLines->GetComponentsNb(), NULL);
413     myChartLines->bindAttribute (aCtx, Graphic3d_TOA_COLOR, 4, GL_UNSIGNED_BYTE, myChartLines->GetComponentsNb(), (void* )sizeof(Graphic3d_Vec3));
414     aCtx->core15fwd->glDrawArrays (GL_LINES, 0, myChartLines->GetElemsNb());
415     myChartLines->Unbind (aCtx);
416     myChartLines->unbindAttribute (aCtx, Graphic3d_TOA_COLOR);
417     myChartLines->unbindAttribute (aCtx, Graphic3d_TOA_POS);
418
419     myChartLabels[0].Render (theWorkspace);
420     myChartLabels[1].Render (theWorkspace);
421     myChartLabels[2].Render (theWorkspace);
422
423     aCtx->WorldViewState.Pop();
424   }
425
426   aCtx->ModelWorldState.Pop();
427   aCtx->ApplyWorldViewMatrix();
428
429   theWorkspace->SetAspectText (aTextAspectBack);
430   if (theWorkspace->UseDepthWrite() != wasEnabledDepth)
431   {
432     theWorkspace->UseDepthWrite() = wasEnabledDepth;
433     glDepthMask (wasEnabledDepth ? GL_TRUE : GL_FALSE);
434   }
435 }