2 * Copyright (c) 2015 Samsung Electronics Co., Ltd.
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
8 * http://www.apache.org/licenses/LICENSE-2.0
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.
19 #include "environment-options.h"
23 #include <dali/integration-api/render-controller.h>
24 #include <dali/public-api/math/math-utils.h>
27 #include <base/environment-variables.h>
40 const unsigned int DEFAULT_STATISTICS_LOG_FREQUENCY = 2;
42 unsigned int GetIntegerEnvironmentVariable( const char* variable, unsigned int defaultValue )
44 const char* variableParameter = std::getenv(variable);
46 // if the parameter exists convert it to an integer, else return the default value
47 unsigned int intValue = variableParameter ? std::atoi(variableParameter) : defaultValue;
51 bool GetIntegerEnvironmentVariable( const char* variable, int& intValue )
53 const char* variableParameter = std::getenv(variable);
55 if( !variableParameter )
59 // if the parameter exists convert it to an integer, else return the default value
60 intValue = std::atoi(variableParameter);
64 bool GetFloatEnvironmentVariable( const char* variable, float& floatValue )
66 const char* variableParameter = std::getenv(variable);
68 if( !variableParameter )
72 // if the parameter exists convert it to an integer, else return the default value
73 floatValue = std::atof(variableParameter);
77 const char * GetCharEnvironmentVariable( const char * variable )
79 return std::getenv( variable );
82 } // unnamed namespace
84 EnvironmentOptions::EnvironmentOptions()
89 mUpdateStatusFrequency(0),
90 mObjectProfilerInterval( 0 ),
91 mPerformanceStatsLevel(0),
92 mPerformanceStatsFrequency( DEFAULT_STATISTICS_LOG_FREQUENCY ),
93 mPerformanceTimeStampOutput(0),
94 mPanGestureLoggingLevel(0),
95 mPanGesturePredictionMode(-1),
96 mPanGesturePredictionAmount(-1), ///< only sets value in pan gesture if greater than 0
97 mPanGestureMaxPredictionAmount(-1),
98 mPanGestureMinPredictionAmount(-1),
99 mPanGesturePredictionAmountAdjustment(-1),
100 mPanGestureSmoothingMode(-1),
101 mPanGestureSmoothingAmount(-1.0f),
102 mPanMinimumDistance(-1),
103 mPanMinimumEvents(-1),
107 mThreadingMode( ThreadingMode::COMBINED_UPDATE_RENDER ),
108 mRenderRefreshRate( 1 ),
109 mGlesCallAccumulate( false ),
110 mMultiSamplingLevel( 0 ),
113 ParseEnvironmentOptions();
116 EnvironmentOptions::~EnvironmentOptions()
120 void EnvironmentOptions::SetLogFunction( const Dali::Integration::Log::LogFunction& logFunction )
122 mLogFunction = logFunction;
125 void EnvironmentOptions::InstallLogFunction() const
127 Dali::Integration::Log::InstallLogFunction( mLogFunction );
130 void EnvironmentOptions::UnInstallLogFunction() const
132 Dali::Integration::Log::UninstallLogFunction();
135 unsigned int EnvironmentOptions::GetNetworkControlMode() const
137 return mNetworkControl;
139 unsigned int EnvironmentOptions::GetFrameRateLoggingFrequency() const
141 return mFpsFrequency;
144 unsigned int EnvironmentOptions::GetUpdateStatusLoggingFrequency() const
146 return mUpdateStatusFrequency;
149 unsigned int EnvironmentOptions::GetObjectProfilerInterval() const
151 return mObjectProfilerInterval;
154 unsigned int EnvironmentOptions::GetPerformanceStatsLoggingOptions() const
156 return mPerformanceStatsLevel;
158 unsigned int EnvironmentOptions::GetPerformanceStatsLoggingFrequency() const
160 return mPerformanceStatsFrequency;
162 unsigned int EnvironmentOptions::GetPerformanceTimeStampOutput() const
164 return mPerformanceTimeStampOutput;
167 unsigned int EnvironmentOptions::GetPanGestureLoggingLevel() const
169 return mPanGestureLoggingLevel;
172 int EnvironmentOptions::GetPanGesturePredictionMode() const
174 return mPanGesturePredictionMode;
177 int EnvironmentOptions::GetPanGesturePredictionAmount() const
179 return mPanGesturePredictionAmount;
182 int EnvironmentOptions::GetPanGestureMaximumPredictionAmount() const
184 return mPanGestureMaxPredictionAmount;
187 int EnvironmentOptions::GetPanGestureMinimumPredictionAmount() const
189 return mPanGestureMinPredictionAmount;
192 int EnvironmentOptions::GetPanGesturePredictionAmountAdjustment() const
194 return mPanGesturePredictionAmountAdjustment;
197 int EnvironmentOptions::GetPanGestureSmoothingMode() const
199 return mPanGestureSmoothingMode;
202 float EnvironmentOptions::GetPanGestureSmoothingAmount() const
204 return mPanGestureSmoothingAmount;
207 int EnvironmentOptions::GetMinimumPanDistance() const
209 return mPanMinimumDistance;
212 int EnvironmentOptions::GetMinimumPanEvents() const
214 return mPanMinimumEvents;
217 unsigned int EnvironmentOptions::GetWindowWidth() const
222 unsigned int EnvironmentOptions::GetWindowHeight() const
224 return mWindowHeight;
227 int EnvironmentOptions::GetGlesCallTime() const
229 return mGlesCallTime;
232 bool EnvironmentOptions::GetGlesCallAccumulate() const
234 return mGlesCallAccumulate;
237 const std::string& EnvironmentOptions::GetWindowName() const
242 const std::string& EnvironmentOptions::GetWindowClassName() const
244 return mWindowClassName;
247 ThreadingMode::Type EnvironmentOptions::GetThreadingMode() const
249 return mThreadingMode;
252 unsigned int EnvironmentOptions::GetRenderRefreshRate() const
254 return mRenderRefreshRate;
257 unsigned int EnvironmentOptions::GetMultiSamplingLevel() const
259 return mMultiSamplingLevel;
262 bool EnvironmentOptions::PerformanceServerRequired() const
264 return ( ( GetPerformanceStatsLoggingOptions() > 0) ||
265 ( GetPerformanceTimeStampOutput() > 0 ) ||
266 ( GetNetworkControlMode() > 0) );
269 void EnvironmentOptions::ParseEnvironmentOptions()
271 // get logging options
272 mFpsFrequency = GetIntegerEnvironmentVariable( DALI_ENV_FPS_TRACKING, 0 );
273 mUpdateStatusFrequency = GetIntegerEnvironmentVariable( DALI_ENV_UPDATE_STATUS_INTERVAL, 0 );
274 mObjectProfilerInterval = GetIntegerEnvironmentVariable( DALI_ENV_OBJECT_PROFILER_INTERVAL, 0 );
275 mPerformanceStatsLevel = GetIntegerEnvironmentVariable( DALI_ENV_LOG_PERFORMANCE_STATS, 0 );
276 mPerformanceStatsFrequency = GetIntegerEnvironmentVariable( DALI_ENV_LOG_PERFORMANCE_STATS_FREQUENCY, 0 );
277 mPerformanceTimeStampOutput = GetIntegerEnvironmentVariable( DALI_ENV_PERFORMANCE_TIMESTAMP_OUTPUT, 0 );
278 mNetworkControl = GetIntegerEnvironmentVariable( DALI_ENV_NETWORK_CONTROL, 0 );
279 mPanGestureLoggingLevel = GetIntegerEnvironmentVariable( DALI_ENV_LOG_PAN_GESTURE, 0 );
282 if( GetIntegerEnvironmentVariable(DALI_ENV_PAN_PREDICTION_MODE, predictionMode) )
284 mPanGesturePredictionMode = predictionMode;
286 int predictionAmount(-1);
287 if( GetIntegerEnvironmentVariable(DALI_ENV_PAN_PREDICTION_AMOUNT, predictionAmount) )
289 if( predictionAmount < 0 )
291 // do not support times in the past
292 predictionAmount = 0;
294 mPanGesturePredictionAmount = predictionAmount;
296 int minPredictionAmount(-1);
297 if( GetIntegerEnvironmentVariable(DALI_ENV_PAN_MIN_PREDICTION_AMOUNT, minPredictionAmount) )
299 if( minPredictionAmount < 0 )
301 // do not support times in the past
302 minPredictionAmount = 0;
304 mPanGestureMinPredictionAmount = minPredictionAmount;
306 int maxPredictionAmount(-1);
307 if( GetIntegerEnvironmentVariable(DALI_ENV_PAN_MAX_PREDICTION_AMOUNT, maxPredictionAmount) )
309 if( minPredictionAmount > -1 && maxPredictionAmount < minPredictionAmount )
311 // maximum amount should not be smaller than minimum amount
312 maxPredictionAmount = minPredictionAmount;
314 mPanGestureMaxPredictionAmount = maxPredictionAmount;
316 int predictionAmountAdjustment(-1);
317 if( GetIntegerEnvironmentVariable(DALI_ENV_PAN_PREDICTION_AMOUNT_ADJUSTMENT, predictionAmountAdjustment) )
319 if( predictionAmountAdjustment < 0 )
321 // negative amount doesn't make sense
322 predictionAmountAdjustment = 0;
324 mPanGesturePredictionAmountAdjustment = predictionAmountAdjustment;
327 if( GetIntegerEnvironmentVariable(DALI_ENV_PAN_SMOOTHING_MODE, smoothingMode) )
329 mPanGestureSmoothingMode = smoothingMode;
331 float smoothingAmount = 1.0f;
332 if( GetFloatEnvironmentVariable(DALI_ENV_PAN_SMOOTHING_AMOUNT, smoothingAmount) )
334 smoothingAmount = Clamp(smoothingAmount, 0.0f, 1.0f);
335 mPanGestureSmoothingAmount = smoothingAmount;
338 int minimumDistance(-1);
339 if ( GetIntegerEnvironmentVariable(DALI_ENV_PAN_MINIMUM_DISTANCE, minimumDistance ))
341 mPanMinimumDistance = minimumDistance;
344 int minimumEvents(-1);
345 if ( GetIntegerEnvironmentVariable(DALI_ENV_PAN_MINIMUM_EVENTS, minimumEvents ))
347 mPanMinimumEvents = minimumEvents;
351 if ( GetIntegerEnvironmentVariable(DALI_GLES_CALL_TIME, glesCallTime ))
353 mGlesCallTime = glesCallTime;
356 int glesCallAccumulate( 0 );
357 if ( GetIntegerEnvironmentVariable( DALI_GLES_CALL_ACCUMULATE, glesCallAccumulate ) )
359 mGlesCallAccumulate = glesCallAccumulate != 0;
362 int windowWidth(0), windowHeight(0);
363 if ( GetIntegerEnvironmentVariable( DALI_WINDOW_WIDTH, windowWidth ) && GetIntegerEnvironmentVariable( DALI_WINDOW_HEIGHT, windowHeight ) )
365 mWindowWidth = windowWidth;
366 mWindowHeight = windowHeight;
369 const char * windowName = GetCharEnvironmentVariable( DALI_WINDOW_NAME );
372 mWindowName = windowName;
375 const char * windowClassName = GetCharEnvironmentVariable( DALI_WINDOW_CLASS_NAME );
376 if ( windowClassName )
378 mWindowClassName = windowClassName;
381 int threadingMode(0);
382 if ( GetIntegerEnvironmentVariable( DALI_THREADING_MODE, threadingMode ) )
384 switch( threadingMode )
386 case ThreadingMode::SEPARATE_UPDATE_RENDER:
387 case ThreadingMode::COMBINED_UPDATE_RENDER:
388 case ThreadingMode::SINGLE_THREADED:
390 mThreadingMode = static_cast< ThreadingMode::Type >( threadingMode );
396 int renderRefreshRate(0);
397 if ( GetIntegerEnvironmentVariable( DALI_REFRESH_RATE, renderRefreshRate ) )
399 // Only change it if it's valid
400 if( renderRefreshRate > 1 )
402 mRenderRefreshRate = renderRefreshRate;
406 int multiSamplingLevel( 0 );
407 if( GetIntegerEnvironmentVariable( DALI_ENV_MULTI_SAMPLING_LEVEL, multiSamplingLevel ) )
409 if( multiSamplingLevel > 0 )
411 mMultiSamplingLevel = multiSamplingLevel;