[Tizen] Implement partial update
[platform/core/uifw/dali-adaptor.git] / dali / internal / system / common / environment-options.cpp
1 /*
2  * Copyright (c) 2019 Samsung Electronics Co., Ltd.
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  *
16  */
17
18 // CLASS HEADER
19 #include <dali/internal/system/common/environment-options.h>
20
21 // EXTERNAL INCLUDES
22 #include <cstdlib>
23 #include <dali/integration-api/render-controller.h>
24 #include <dali/public-api/math/math-utils.h>
25
26 // INTERNAL INCLUDES
27 #include <dali/internal/trace/common/trace-factory.h>
28 #include <dali/internal/system/common/environment-variables.h>
29
30 namespace Dali
31 {
32
33 namespace Internal
34 {
35
36 namespace Adaptor
37 {
38
39 namespace
40 {
41 const unsigned int DEFAULT_STATISTICS_LOG_FREQUENCY = 2;
42 const int DEFAULT_MULTI_SAMPLING_LEVEL = -1;
43 const bool DEFAULT_DEPTH_BUFFER_REQUIRED_SETTING = true;
44 const bool DEFAULT_STENCIL_BUFFER_REQUIRED_SETTING = true;
45
46 unsigned int GetIntegerEnvironmentVariable( const char* variable, unsigned int defaultValue )
47 {
48   const char* variableParameter = std::getenv(variable);
49
50   // if the parameter exists convert it to an integer, else return the default value
51   unsigned int intValue = variableParameter ? std::atoi(variableParameter) : defaultValue;
52   return intValue;
53 }
54
55 bool GetIntegerEnvironmentVariable( const char* variable, int& intValue )
56 {
57   const char* variableParameter = std::getenv(variable);
58
59   if( !variableParameter )
60   {
61     return false;
62   }
63   // if the parameter exists convert it to an integer, else return the default value
64   intValue = std::atoi(variableParameter);
65   return true;
66 }
67
68 bool GetFloatEnvironmentVariable( const char* variable, float& floatValue )
69 {
70   const char* variableParameter = std::getenv(variable);
71
72   if( !variableParameter )
73   {
74     return false;
75   }
76   // if the parameter exists convert it to an integer, else return the default value
77   floatValue = std::atof(variableParameter);
78   return true;
79 }
80
81 const char * GetCharEnvironmentVariable( const char * variable )
82 {
83   return std::getenv( variable );
84 }
85
86 } // unnamed namespace
87
88 EnvironmentOptions::EnvironmentOptions()
89 : mLogFunction( NULL ),
90   mWindowName(),
91   mWindowClassName(),
92   mNetworkControl( 0 ),
93   mFpsFrequency( 0 ),
94   mUpdateStatusFrequency( 0 ),
95   mObjectProfilerInterval( 0 ),
96   mPerformanceStatsLevel( 0 ),
97   mPerformanceStatsFrequency( DEFAULT_STATISTICS_LOG_FREQUENCY ),
98   mPerformanceTimeStampOutput( 0 ),
99   mPanGestureLoggingLevel( 0 ),
100   mWindowWidth( 0u ),
101   mWindowHeight( 0u ),
102   mRenderRefreshRate( 1u ),
103   mMaxTextureSize( 0 ),
104   mRenderToFboInterval( 0u ),
105   mPanGesturePredictionMode( -1 ),
106   mPanGesturePredictionAmount( -1 ), ///< only sets value in pan gesture if greater than 0
107   mPanGestureMaxPredictionAmount( -1 ),
108   mPanGestureMinPredictionAmount( -1 ),
109   mPanGesturePredictionAmountAdjustment( -1 ),
110   mPanGestureSmoothingMode( -1 ),
111   mPanGestureSmoothingAmount( -1.0f ),
112   mPanGestureUseActualTimes( -1 ),
113   mPanGestureInterpolationTimeRange( -1 ),
114   mPanGestureScalarOnlyPredictionEnabled( -1 ),
115   mPanGestureTwoPointPredictionEnabled( -1 ),
116   mPanGestureTwoPointInterpolatePastTime( -1 ),
117   mPanGestureTwoPointVelocityBias( -1.0f ),
118   mPanGestureTwoPointAccelerationBias( -1.0f ),
119   mPanGestureMultitapSmoothingRange( -1 ),
120   mPanMinimumDistance( -1 ),
121   mPanMinimumEvents( -1 ),
122   mPinchMinimumDistance( -1.0f ),
123   mGlesCallTime( 0 ),
124   mMultiSamplingLevel( DEFAULT_MULTI_SAMPLING_LEVEL ),
125   mThreadingMode( ThreadingMode::COMBINED_UPDATE_RENDER ),
126   mGlesCallAccumulate( false ),
127   mDepthBufferRequired( DEFAULT_DEPTH_BUFFER_REQUIRED_SETTING ),
128   mStencilBufferRequired( DEFAULT_STENCIL_BUFFER_REQUIRED_SETTING ),
129   mPartialUpdateAvailable( false )
130 {
131   ParseEnvironmentOptions();
132 }
133
134 EnvironmentOptions::~EnvironmentOptions()
135 {
136 }
137
138 void EnvironmentOptions::CreateTraceManager( PerformanceInterface* performanceInterface )
139 {
140   mTraceManager = TraceManagerFactory::CreateTraceFactory( performanceInterface );
141 }
142
143 void EnvironmentOptions::InstallTraceFunction() const
144 {
145   if( mTraceManager )
146   {
147     mTraceManager->Initialise();
148   }
149 }
150
151 void EnvironmentOptions::SetLogFunction( const Dali::Integration::Log::LogFunction& logFunction )
152 {
153   mLogFunction = logFunction;
154 }
155
156 void EnvironmentOptions::InstallLogFunction() const
157 {
158   Dali::Integration::Log::InstallLogFunction( mLogFunction );
159 }
160
161 void EnvironmentOptions::UnInstallLogFunction() const
162 {
163   Dali::Integration::Log::UninstallLogFunction();
164 }
165
166 unsigned int EnvironmentOptions::GetNetworkControlMode() const
167 {
168   return mNetworkControl;
169 }
170 unsigned int EnvironmentOptions::GetFrameRateLoggingFrequency() const
171 {
172   return mFpsFrequency;
173 }
174
175 unsigned int EnvironmentOptions::GetUpdateStatusLoggingFrequency() const
176 {
177   return mUpdateStatusFrequency;
178 }
179
180 unsigned int EnvironmentOptions::GetObjectProfilerInterval() const
181 {
182   return mObjectProfilerInterval;
183 }
184
185 unsigned int EnvironmentOptions::GetPerformanceStatsLoggingOptions() const
186 {
187   return mPerformanceStatsLevel;
188 }
189 unsigned int EnvironmentOptions::GetPerformanceStatsLoggingFrequency() const
190 {
191   return mPerformanceStatsFrequency;
192 }
193 unsigned int EnvironmentOptions::GetPerformanceTimeStampOutput() const
194 {
195   return mPerformanceTimeStampOutput;
196 }
197
198 unsigned int EnvironmentOptions::GetPanGestureLoggingLevel() const
199 {
200   return mPanGestureLoggingLevel;
201 }
202
203 int EnvironmentOptions::GetPanGesturePredictionMode() const
204 {
205   return mPanGesturePredictionMode;
206 }
207
208 int EnvironmentOptions::GetPanGesturePredictionAmount() const
209 {
210   return mPanGesturePredictionAmount;
211 }
212
213 int EnvironmentOptions::GetPanGestureMaximumPredictionAmount() const
214 {
215   return mPanGestureMaxPredictionAmount;
216 }
217
218 int EnvironmentOptions::GetPanGestureMinimumPredictionAmount() const
219 {
220   return mPanGestureMinPredictionAmount;
221 }
222
223 int EnvironmentOptions::GetPanGesturePredictionAmountAdjustment() const
224 {
225   return mPanGesturePredictionAmountAdjustment;
226 }
227
228 int EnvironmentOptions::GetPanGestureSmoothingMode() const
229 {
230   return mPanGestureSmoothingMode;
231 }
232
233 float EnvironmentOptions::GetPanGestureSmoothingAmount() const
234 {
235   return mPanGestureSmoothingAmount;
236 }
237
238 int EnvironmentOptions::GetPanGestureUseActualTimes() const
239 {
240   return mPanGestureUseActualTimes;
241 }
242
243 int EnvironmentOptions::GetPanGestureInterpolationTimeRange() const
244 {
245   return mPanGestureInterpolationTimeRange;
246 }
247
248 int EnvironmentOptions::GetPanGestureScalarOnlyPredictionEnabled() const
249 {
250   return mPanGestureScalarOnlyPredictionEnabled;
251 }
252
253 int EnvironmentOptions::GetPanGestureTwoPointPredictionEnabled() const
254 {
255   return mPanGestureTwoPointPredictionEnabled;
256 }
257
258 int EnvironmentOptions::GetPanGestureTwoPointInterpolatePastTime() const
259 {
260   return mPanGestureTwoPointInterpolatePastTime;
261 }
262
263 float EnvironmentOptions::GetPanGestureTwoPointVelocityBias() const
264 {
265   return mPanGestureTwoPointVelocityBias;
266 }
267
268 float EnvironmentOptions::GetPanGestureTwoPointAccelerationBias() const
269 {
270   return mPanGestureTwoPointAccelerationBias;
271 }
272
273 int EnvironmentOptions::GetPanGestureMultitapSmoothingRange() const
274 {
275   return mPanGestureMultitapSmoothingRange;
276 }
277
278 int EnvironmentOptions::GetMinimumPanDistance() const
279 {
280   return mPanMinimumDistance;
281 }
282
283 int EnvironmentOptions::GetMinimumPanEvents() const
284 {
285   return mPanMinimumEvents;
286 }
287
288 float EnvironmentOptions::GetMinimumPinchDistance() const
289 {
290   return mPinchMinimumDistance;
291 }
292
293 unsigned int EnvironmentOptions::GetWindowWidth() const
294 {
295   return mWindowWidth;
296 }
297
298 unsigned int EnvironmentOptions::GetWindowHeight() const
299 {
300   return mWindowHeight;
301 }
302
303 int EnvironmentOptions::GetGlesCallTime() const
304 {
305   return mGlesCallTime;
306 }
307
308 bool EnvironmentOptions::GetGlesCallAccumulate() const
309 {
310   return mGlesCallAccumulate;
311 }
312
313 const std::string& EnvironmentOptions::GetWindowName() const
314 {
315   return mWindowName;
316 }
317
318 const std::string& EnvironmentOptions::GetWindowClassName() const
319 {
320   return mWindowClassName;
321 }
322
323 ThreadingMode::Type EnvironmentOptions::GetThreadingMode() const
324 {
325   return mThreadingMode;
326 }
327
328 unsigned int EnvironmentOptions::GetRenderRefreshRate() const
329 {
330   return mRenderRefreshRate;
331 }
332
333 int EnvironmentOptions::GetMultiSamplingLevel() const
334 {
335   return mMultiSamplingLevel;
336 }
337
338 unsigned int EnvironmentOptions::GetMaxTextureSize() const
339 {
340   return mMaxTextureSize;
341 }
342
343 unsigned int EnvironmentOptions::GetRenderToFboInterval() const
344 {
345   return mRenderToFboInterval;
346 }
347
348 bool EnvironmentOptions::PerformanceServerRequired() const
349 {
350   return ( ( GetPerformanceStatsLoggingOptions() > 0) ||
351            ( GetPerformanceTimeStampOutput() > 0 ) ||
352            ( GetNetworkControlMode() > 0) );
353 }
354
355 bool EnvironmentOptions::DepthBufferRequired() const
356 {
357   return mDepthBufferRequired;
358 }
359
360 bool EnvironmentOptions::StencilBufferRequired() const
361 {
362   return mStencilBufferRequired;
363 }
364
365 bool EnvironmentOptions::PartialUpdateAvailable() const
366 {
367   return mPartialUpdateAvailable;
368 }
369
370 void EnvironmentOptions::ParseEnvironmentOptions()
371 {
372   // get logging options
373   mFpsFrequency = GetIntegerEnvironmentVariable( DALI_ENV_FPS_TRACKING, 0 );
374   mUpdateStatusFrequency = GetIntegerEnvironmentVariable( DALI_ENV_UPDATE_STATUS_INTERVAL, 0 );
375   mObjectProfilerInterval = GetIntegerEnvironmentVariable( DALI_ENV_OBJECT_PROFILER_INTERVAL, 0 );
376   mPerformanceStatsLevel = GetIntegerEnvironmentVariable( DALI_ENV_LOG_PERFORMANCE_STATS, 0 );
377   mPerformanceStatsFrequency = GetIntegerEnvironmentVariable( DALI_ENV_LOG_PERFORMANCE_STATS_FREQUENCY, 0 );
378   mPerformanceTimeStampOutput = GetIntegerEnvironmentVariable( DALI_ENV_PERFORMANCE_TIMESTAMP_OUTPUT, 0 );
379   mNetworkControl = GetIntegerEnvironmentVariable( DALI_ENV_NETWORK_CONTROL, 0 );
380   mPanGestureLoggingLevel = GetIntegerEnvironmentVariable( DALI_ENV_LOG_PAN_GESTURE, 0 );
381
382   int predictionMode;
383   if( GetIntegerEnvironmentVariable(DALI_ENV_PAN_PREDICTION_MODE, predictionMode) )
384   {
385     mPanGesturePredictionMode = predictionMode;
386   }
387   int predictionAmount(-1);
388   if( GetIntegerEnvironmentVariable(DALI_ENV_PAN_PREDICTION_AMOUNT, predictionAmount) )
389   {
390     if( predictionAmount < 0 )
391     {
392       // do not support times in the past
393       predictionAmount = 0;
394     }
395     mPanGesturePredictionAmount = predictionAmount;
396   }
397   int minPredictionAmount(-1);
398   if( GetIntegerEnvironmentVariable(DALI_ENV_PAN_MIN_PREDICTION_AMOUNT, minPredictionAmount) )
399   {
400     if( minPredictionAmount < 0 )
401     {
402       // do not support times in the past
403       minPredictionAmount = 0;
404     }
405     mPanGestureMinPredictionAmount = minPredictionAmount;
406   }
407   int maxPredictionAmount(-1);
408   if( GetIntegerEnvironmentVariable(DALI_ENV_PAN_MAX_PREDICTION_AMOUNT, maxPredictionAmount) )
409   {
410     if( minPredictionAmount > -1 && maxPredictionAmount < minPredictionAmount )
411     {
412       // maximum amount should not be smaller than minimum amount
413       maxPredictionAmount = minPredictionAmount;
414     }
415     mPanGestureMaxPredictionAmount = maxPredictionAmount;
416   }
417   int predictionAmountAdjustment(-1);
418   if( GetIntegerEnvironmentVariable(DALI_ENV_PAN_PREDICTION_AMOUNT_ADJUSTMENT, predictionAmountAdjustment) )
419   {
420     if( predictionAmountAdjustment < 0 )
421     {
422       // negative amount doesn't make sense
423       predictionAmountAdjustment = 0;
424     }
425     mPanGesturePredictionAmountAdjustment = predictionAmountAdjustment;
426   }
427   int smoothingMode;
428   if( GetIntegerEnvironmentVariable(DALI_ENV_PAN_SMOOTHING_MODE, smoothingMode) )
429   {
430     mPanGestureSmoothingMode = smoothingMode;
431   }
432   float smoothingAmount = 1.0f;
433   if( GetFloatEnvironmentVariable(DALI_ENV_PAN_SMOOTHING_AMOUNT, smoothingAmount) )
434   {
435     smoothingAmount = Clamp(smoothingAmount, 0.0f, 1.0f);
436     mPanGestureSmoothingAmount = smoothingAmount;
437   }
438
439   int useActualTimes( -1 );
440   if( GetIntegerEnvironmentVariable( DALI_ENV_PAN_USE_ACTUAL_TIMES, useActualTimes ) )
441   {
442     mPanGestureUseActualTimes = useActualTimes == 0 ? 0 : 1;
443   }
444
445   int interpolationTimeRange( -1 );
446   if( GetIntegerEnvironmentVariable( DALI_ENV_PAN_INTERPOLATION_TIME_RANGE, interpolationTimeRange ) )
447   {
448     if( interpolationTimeRange < 0 )
449     {
450       interpolationTimeRange = 0;
451     }
452     mPanGestureInterpolationTimeRange = interpolationTimeRange;
453   }
454
455   int scalarOnlyPredictionEnabled( -1 );
456   if( GetIntegerEnvironmentVariable( DALI_ENV_PAN_SCALAR_ONLY_PREDICTION_ENABLED, scalarOnlyPredictionEnabled ) )
457   {
458     mPanGestureScalarOnlyPredictionEnabled = scalarOnlyPredictionEnabled == 0 ? 0 : 1;
459   }
460
461   int twoPointPredictionEnabled( -1 );
462   if( GetIntegerEnvironmentVariable( DALI_ENV_PAN_TWO_POINT_PREDICTION_ENABLED, twoPointPredictionEnabled ) )
463   {
464     mPanGestureTwoPointPredictionEnabled = twoPointPredictionEnabled == 0 ? 0 : 1;
465   }
466
467   int twoPointPastInterpolateTime( -1 );
468   if( GetIntegerEnvironmentVariable( DALI_ENV_PAN_TWO_POINT_PAST_INTERPOLATE_TIME, twoPointPastInterpolateTime ) )
469   {
470     if( twoPointPastInterpolateTime < 0 )
471     {
472       twoPointPastInterpolateTime = 0;
473     }
474     mPanGestureTwoPointInterpolatePastTime = twoPointPastInterpolateTime;
475   }
476
477   float twoPointVelocityBias = -1.0f;
478   if( GetFloatEnvironmentVariable( DALI_ENV_PAN_TWO_POINT_VELOCITY_BIAS, twoPointVelocityBias ) )
479   {
480     twoPointVelocityBias = Clamp( twoPointVelocityBias, 0.0f, 1.0f );
481     mPanGestureTwoPointVelocityBias = twoPointVelocityBias;
482   }
483
484   float twoPointAccelerationBias = -1.0f;
485   if( GetFloatEnvironmentVariable( DALI_ENV_PAN_TWO_POINT_ACCELERATION_BIAS, twoPointAccelerationBias ) )
486   {
487     twoPointAccelerationBias = Clamp( twoPointAccelerationBias, 0.0f, 1.0f );
488     mPanGestureTwoPointAccelerationBias = twoPointAccelerationBias;
489   }
490
491   int multitapSmoothingRange( -1 );
492   if( GetIntegerEnvironmentVariable( DALI_ENV_PAN_MULTITAP_SMOOTHING_RANGE, multitapSmoothingRange ) )
493   {
494     if( multitapSmoothingRange < 0 )
495     {
496       multitapSmoothingRange = 0;
497     }
498     mPanGestureMultitapSmoothingRange = multitapSmoothingRange;
499   }
500
501   int minimumDistance(-1);
502   if ( GetIntegerEnvironmentVariable(DALI_ENV_PAN_MINIMUM_DISTANCE, minimumDistance ))
503   {
504     mPanMinimumDistance = minimumDistance;
505   }
506
507   int minimumEvents(-1);
508   if ( GetIntegerEnvironmentVariable(DALI_ENV_PAN_MINIMUM_EVENTS, minimumEvents ))
509   {
510     mPanMinimumEvents = minimumEvents;
511   }
512
513   float pinchMinimumDistance = -1.0f;
514   if( GetFloatEnvironmentVariable( DALI_ENV_PINCH_MINIMUM_DISTANCE, pinchMinimumDistance ) )
515   {
516     mPinchMinimumDistance = pinchMinimumDistance;
517   }
518
519   int glesCallTime(0);
520   if ( GetIntegerEnvironmentVariable(DALI_GLES_CALL_TIME, glesCallTime ))
521   {
522     mGlesCallTime = glesCallTime;
523   }
524
525   int glesCallAccumulate( 0 );
526   if ( GetIntegerEnvironmentVariable( DALI_GLES_CALL_ACCUMULATE, glesCallAccumulate ) )
527   {
528     mGlesCallAccumulate = glesCallAccumulate != 0;
529   }
530
531   int windowWidth(0), windowHeight(0);
532   if ( GetIntegerEnvironmentVariable( DALI_WINDOW_WIDTH, windowWidth ) && GetIntegerEnvironmentVariable( DALI_WINDOW_HEIGHT, windowHeight ) )
533   {
534     mWindowWidth = windowWidth;
535     mWindowHeight = windowHeight;
536   }
537
538   const char * windowName = GetCharEnvironmentVariable( DALI_WINDOW_NAME );
539   if ( windowName )
540   {
541     mWindowName = windowName;
542   }
543
544   const char * windowClassName = GetCharEnvironmentVariable( DALI_WINDOW_CLASS_NAME );
545   if ( windowClassName )
546   {
547     mWindowClassName = windowClassName;
548   }
549
550   int threadingMode(0);
551   if ( GetIntegerEnvironmentVariable( DALI_THREADING_MODE, threadingMode ) )
552   {
553     switch( threadingMode )
554     {
555       case ThreadingMode::COMBINED_UPDATE_RENDER:
556       {
557         mThreadingMode = static_cast< ThreadingMode::Type >( threadingMode );
558         break;
559       }
560     }
561   }
562
563   int renderRefreshRate(0);
564   if ( GetIntegerEnvironmentVariable( DALI_REFRESH_RATE, renderRefreshRate ) )
565   {
566     // Only change it if it's valid
567     if( renderRefreshRate > 1 )
568     {
569       mRenderRefreshRate = renderRefreshRate;
570     }
571   }
572
573   int multiSamplingLevel( 0 );
574   if( GetIntegerEnvironmentVariable( DALI_ENV_MULTI_SAMPLING_LEVEL, multiSamplingLevel ) )
575   {
576     mMultiSamplingLevel = multiSamplingLevel;
577   }
578
579   int maxTextureSize( 0 );
580   if( GetIntegerEnvironmentVariable( DALI_ENV_MAX_TEXTURE_SIZE, maxTextureSize ) )
581   {
582     if( maxTextureSize > 0 )
583     {
584       mMaxTextureSize = maxTextureSize;
585     }
586   }
587
588   mRenderToFboInterval = GetIntegerEnvironmentVariable( DALI_RENDER_TO_FBO, 0u );
589
590
591   int depthBufferRequired( -1 );
592   if( GetIntegerEnvironmentVariable( DALI_ENV_DISABLE_DEPTH_BUFFER, depthBufferRequired ) )
593   {
594     if( depthBufferRequired > 0 )
595     {
596       mDepthBufferRequired = false;
597       mStencilBufferRequired = false; // Disable stencil buffer as well
598     }
599   }
600
601   int stencilBufferRequired( -1 );
602   if( GetIntegerEnvironmentVariable( DALI_ENV_DISABLE_STENCIL_BUFFER, stencilBufferRequired ) )
603   {
604     if( stencilBufferRequired > 0 )
605     {
606       mStencilBufferRequired = false;
607     }
608   }
609
610   int partialUpdateRequired( -1 );
611   if( GetIntegerEnvironmentVariable( DALI_ENV_PARTIAL_UPDATE_AVAILABLE, partialUpdateRequired ) )
612   {
613     if( partialUpdateRequired > 0 )
614     {
615       mPartialUpdateAvailable = true;
616     }
617   }
618 }
619
620 } // Adaptor
621
622 } // Internal
623
624 } // Dali