2 * Copyright (c) 2017 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 ),
111 mMaxTextureSize( 0 ),
114 ParseEnvironmentOptions();
117 EnvironmentOptions::~EnvironmentOptions()
121 void EnvironmentOptions::SetLogFunction( const Dali::Integration::Log::LogFunction& logFunction )
123 mLogFunction = logFunction;
126 void EnvironmentOptions::InstallLogFunction() const
128 Dali::Integration::Log::InstallLogFunction( mLogFunction );
131 void EnvironmentOptions::UnInstallLogFunction() const
133 Dali::Integration::Log::UninstallLogFunction();
136 unsigned int EnvironmentOptions::GetNetworkControlMode() const
138 return mNetworkControl;
140 unsigned int EnvironmentOptions::GetFrameRateLoggingFrequency() const
142 return mFpsFrequency;
145 unsigned int EnvironmentOptions::GetUpdateStatusLoggingFrequency() const
147 return mUpdateStatusFrequency;
150 unsigned int EnvironmentOptions::GetObjectProfilerInterval() const
152 return mObjectProfilerInterval;
155 unsigned int EnvironmentOptions::GetPerformanceStatsLoggingOptions() const
157 return mPerformanceStatsLevel;
159 unsigned int EnvironmentOptions::GetPerformanceStatsLoggingFrequency() const
161 return mPerformanceStatsFrequency;
163 unsigned int EnvironmentOptions::GetPerformanceTimeStampOutput() const
165 return mPerformanceTimeStampOutput;
168 unsigned int EnvironmentOptions::GetPanGestureLoggingLevel() const
170 return mPanGestureLoggingLevel;
173 int EnvironmentOptions::GetPanGesturePredictionMode() const
175 return mPanGesturePredictionMode;
178 int EnvironmentOptions::GetPanGesturePredictionAmount() const
180 return mPanGesturePredictionAmount;
183 int EnvironmentOptions::GetPanGestureMaximumPredictionAmount() const
185 return mPanGestureMaxPredictionAmount;
188 int EnvironmentOptions::GetPanGestureMinimumPredictionAmount() const
190 return mPanGestureMinPredictionAmount;
193 int EnvironmentOptions::GetPanGesturePredictionAmountAdjustment() const
195 return mPanGesturePredictionAmountAdjustment;
198 int EnvironmentOptions::GetPanGestureSmoothingMode() const
200 return mPanGestureSmoothingMode;
203 float EnvironmentOptions::GetPanGestureSmoothingAmount() const
205 return mPanGestureSmoothingAmount;
208 int EnvironmentOptions::GetMinimumPanDistance() const
210 return mPanMinimumDistance;
213 int EnvironmentOptions::GetMinimumPanEvents() const
215 return mPanMinimumEvents;
218 unsigned int EnvironmentOptions::GetWindowWidth() const
223 unsigned int EnvironmentOptions::GetWindowHeight() const
225 return mWindowHeight;
228 int EnvironmentOptions::GetGlesCallTime() const
230 return mGlesCallTime;
233 bool EnvironmentOptions::GetGlesCallAccumulate() const
235 return mGlesCallAccumulate;
238 const std::string& EnvironmentOptions::GetWindowName() const
243 const std::string& EnvironmentOptions::GetWindowClassName() const
245 return mWindowClassName;
248 ThreadingMode::Type EnvironmentOptions::GetThreadingMode() const
250 return mThreadingMode;
253 unsigned int EnvironmentOptions::GetRenderRefreshRate() const
255 return mRenderRefreshRate;
258 unsigned int EnvironmentOptions::GetMultiSamplingLevel() const
260 return mMultiSamplingLevel;
263 unsigned int EnvironmentOptions::GetMaxTextureSize() const
265 return mMaxTextureSize;
268 bool EnvironmentOptions::PerformanceServerRequired() const
270 return ( ( GetPerformanceStatsLoggingOptions() > 0) ||
271 ( GetPerformanceTimeStampOutput() > 0 ) ||
272 ( GetNetworkControlMode() > 0) );
275 void EnvironmentOptions::ParseEnvironmentOptions()
277 // get logging options
278 mFpsFrequency = GetIntegerEnvironmentVariable( DALI_ENV_FPS_TRACKING, 0 );
279 mUpdateStatusFrequency = GetIntegerEnvironmentVariable( DALI_ENV_UPDATE_STATUS_INTERVAL, 0 );
280 mObjectProfilerInterval = GetIntegerEnvironmentVariable( DALI_ENV_OBJECT_PROFILER_INTERVAL, 0 );
281 mPerformanceStatsLevel = GetIntegerEnvironmentVariable( DALI_ENV_LOG_PERFORMANCE_STATS, 0 );
282 mPerformanceStatsFrequency = GetIntegerEnvironmentVariable( DALI_ENV_LOG_PERFORMANCE_STATS_FREQUENCY, 0 );
283 mPerformanceTimeStampOutput = GetIntegerEnvironmentVariable( DALI_ENV_PERFORMANCE_TIMESTAMP_OUTPUT, 0 );
284 mNetworkControl = GetIntegerEnvironmentVariable( DALI_ENV_NETWORK_CONTROL, 0 );
285 mPanGestureLoggingLevel = GetIntegerEnvironmentVariable( DALI_ENV_LOG_PAN_GESTURE, 0 );
288 if( GetIntegerEnvironmentVariable(DALI_ENV_PAN_PREDICTION_MODE, predictionMode) )
290 mPanGesturePredictionMode = predictionMode;
292 int predictionAmount(-1);
293 if( GetIntegerEnvironmentVariable(DALI_ENV_PAN_PREDICTION_AMOUNT, predictionAmount) )
295 if( predictionAmount < 0 )
297 // do not support times in the past
298 predictionAmount = 0;
300 mPanGesturePredictionAmount = predictionAmount;
302 int minPredictionAmount(-1);
303 if( GetIntegerEnvironmentVariable(DALI_ENV_PAN_MIN_PREDICTION_AMOUNT, minPredictionAmount) )
305 if( minPredictionAmount < 0 )
307 // do not support times in the past
308 minPredictionAmount = 0;
310 mPanGestureMinPredictionAmount = minPredictionAmount;
312 int maxPredictionAmount(-1);
313 if( GetIntegerEnvironmentVariable(DALI_ENV_PAN_MAX_PREDICTION_AMOUNT, maxPredictionAmount) )
315 if( minPredictionAmount > -1 && maxPredictionAmount < minPredictionAmount )
317 // maximum amount should not be smaller than minimum amount
318 maxPredictionAmount = minPredictionAmount;
320 mPanGestureMaxPredictionAmount = maxPredictionAmount;
322 int predictionAmountAdjustment(-1);
323 if( GetIntegerEnvironmentVariable(DALI_ENV_PAN_PREDICTION_AMOUNT_ADJUSTMENT, predictionAmountAdjustment) )
325 if( predictionAmountAdjustment < 0 )
327 // negative amount doesn't make sense
328 predictionAmountAdjustment = 0;
330 mPanGesturePredictionAmountAdjustment = predictionAmountAdjustment;
333 if( GetIntegerEnvironmentVariable(DALI_ENV_PAN_SMOOTHING_MODE, smoothingMode) )
335 mPanGestureSmoothingMode = smoothingMode;
337 float smoothingAmount = 1.0f;
338 if( GetFloatEnvironmentVariable(DALI_ENV_PAN_SMOOTHING_AMOUNT, smoothingAmount) )
340 smoothingAmount = Clamp(smoothingAmount, 0.0f, 1.0f);
341 mPanGestureSmoothingAmount = smoothingAmount;
344 int minimumDistance(-1);
345 if ( GetIntegerEnvironmentVariable(DALI_ENV_PAN_MINIMUM_DISTANCE, minimumDistance ))
347 mPanMinimumDistance = minimumDistance;
350 int minimumEvents(-1);
351 if ( GetIntegerEnvironmentVariable(DALI_ENV_PAN_MINIMUM_EVENTS, minimumEvents ))
353 mPanMinimumEvents = minimumEvents;
357 if ( GetIntegerEnvironmentVariable(DALI_GLES_CALL_TIME, glesCallTime ))
359 mGlesCallTime = glesCallTime;
362 int glesCallAccumulate( 0 );
363 if ( GetIntegerEnvironmentVariable( DALI_GLES_CALL_ACCUMULATE, glesCallAccumulate ) )
365 mGlesCallAccumulate = glesCallAccumulate != 0;
368 int windowWidth(0), windowHeight(0);
369 if ( GetIntegerEnvironmentVariable( DALI_WINDOW_WIDTH, windowWidth ) && GetIntegerEnvironmentVariable( DALI_WINDOW_HEIGHT, windowHeight ) )
371 mWindowWidth = windowWidth;
372 mWindowHeight = windowHeight;
375 const char * windowName = GetCharEnvironmentVariable( DALI_WINDOW_NAME );
378 mWindowName = windowName;
381 const char * windowClassName = GetCharEnvironmentVariable( DALI_WINDOW_CLASS_NAME );
382 if ( windowClassName )
384 mWindowClassName = windowClassName;
387 int threadingMode(0);
388 if ( GetIntegerEnvironmentVariable( DALI_THREADING_MODE, threadingMode ) )
390 switch( threadingMode )
392 case ThreadingMode::COMBINED_UPDATE_RENDER:
394 mThreadingMode = static_cast< ThreadingMode::Type >( threadingMode );
400 int renderRefreshRate(0);
401 if ( GetIntegerEnvironmentVariable( DALI_REFRESH_RATE, renderRefreshRate ) )
403 // Only change it if it's valid
404 if( renderRefreshRate > 1 )
406 mRenderRefreshRate = renderRefreshRate;
410 int multiSamplingLevel( 0 );
411 if( GetIntegerEnvironmentVariable( DALI_ENV_MULTI_SAMPLING_LEVEL, multiSamplingLevel ) )
413 if( multiSamplingLevel > 0 )
415 mMultiSamplingLevel = multiSamplingLevel;
419 int maxTextureSize( 0 );
420 if( GetIntegerEnvironmentVariable( DALI_ENV_MAX_TEXTURE_SIZE, maxTextureSize ) )
422 if( maxTextureSize > 0 )
424 mMaxTextureSize = maxTextureSize;