dali/integration-api/adaptor-framework/scene-holder-impl.cpp

   1 /*
   2  * Copyright (c) 2020 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/integration-api/adaptor-framework/scene-holder-impl.h>
  20
  21 // EXTERNAL INCLUDES
  22 #include <sys/time.h>
  23 #include <dali/public-api/common/dali-common.h>
  24 #include <dali/public-api/actors/actor.h>
  25 #include <dali/public-api/actors/layer.h>
  26 #include <dali/integration-api/debug.h>
  27 #include <dali/integration-api/events/key-event-integ.h>
  28 #include <dali/integration-api/events/touch-event-integ.h>
  29 #include <dali/integration-api/events/hover-event-integ.h>
  30 #include <dali/integration-api/events/wheel-event-integ.h>
  31
  32 // INTERNAL INCLUDES
  33 #include <dali/internal/adaptor/common/adaptor-impl.h>
  34 #include <dali/internal/adaptor/common/lifecycle-observer.h>
  35 #include <dali/internal/graphics/gles/egl-graphics.h>
  36 #include <dali/internal/input/common/key-impl.h>
  37 #include <dali/internal/input/common/physical-keyboard-impl.h>
  38
  39 namespace Dali
  40 {
  41
  42 namespace Internal
  43 {
  44
  45 namespace Adaptor
  46 {
  47
  48 namespace
  49 {
  50
  51 #if defined(DEBUG_ENABLED)
  52 Debug::Filter* gSceneHolderLogFilter = Debug::Filter::New( Debug::NoLogging, false, "LOG_SCENE_HOLDER" );
  53 #endif
  54
  55 // Copied from x server
  56 static uint32_t GetCurrentMilliSeconds(void)
  57 {
  58   struct timeval tv;
  59
  60   struct timespec tp;
  61   static clockid_t clockid;
  62
  63   if (!clockid)
  64   {
  65 #ifdef CLOCK_MONOTONIC_COARSE
  66     if (clock_getres(CLOCK_MONOTONIC_COARSE, &tp) == 0 &&
  67       (tp.tv_nsec / 1000) <= 1000 && clock_gettime(CLOCK_MONOTONIC_COARSE, &tp) == 0)
  68     {
  69       clockid = CLOCK_MONOTONIC_COARSE;
  70     }
  71     else
  72 #endif
  73     if (clock_gettime(CLOCK_MONOTONIC, &tp) == 0)
  74     {
  75       clockid = CLOCK_MONOTONIC;
  76     }
  77     else
  78     {
  79       clockid = ~0L;
  80     }
  81   }
  82   if (clockid != ~0L && clock_gettime(clockid, &tp) == 0)
  83   {
  84     return static_cast<uint32_t>( (tp.tv_sec * 1000 ) + (tp.tv_nsec / 1000000L) );
  85   }
  86
  87   gettimeofday(&tv, NULL);
  88   return static_cast<uint32_t>( (tv.tv_sec * 1000 ) + (tv.tv_usec / 1000) );
  89 }
  90
  91 } // unnamed namespace
  92
  93 uint32_t SceneHolder::mSceneHolderCounter = 0;
  94
  95 class SceneHolder::SceneHolderLifeCycleObserver : public LifeCycleObserver
  96 {
  97 public:
  98
  99   SceneHolderLifeCycleObserver(Adaptor*& adaptor)
 100   : mAdaptor( adaptor )
 101   {
 102   };
 103
 104 private: // Adaptor::LifeCycleObserver interface
 105
 106   void OnStart() override {};
 107   void OnPause() override {};
 108   void OnResume() override {};
 109   void OnStop() override {};
 110   void OnDestroy() override
 111   {
 112     mAdaptor = nullptr;
 113   };
 114
 115 private:
 116   Adaptor*& mAdaptor;
 117 };
 118
 119
 120 SceneHolder::SceneHolder()
 121 : mLifeCycleObserver( new SceneHolderLifeCycleObserver( mAdaptor ) ),
 122   mId( mSceneHolderCounter++ ),
 123   mSurface( nullptr ),
 124   mAdaptor( nullptr ),
 125   mDpi(),
 126   mIsBeingDeleted( false ),
 127   mAdaptorStarted( false ),
 128   mVisible( true )
 129 {
 130 }
 131
 132 SceneHolder::~SceneHolder()
 133 {
 134   if ( mAdaptor )
 135   {
 136     mAdaptor->RemoveObserver( *mLifeCycleObserver.get() );
 137     mAdaptor->RemoveWindow( this );
 138
 139     mAdaptor->DeleteSurface( *mSurface.get() );
 140
 141     mAdaptor = nullptr;
 142   }
 143
 144   if ( mScene )
 145   {
 146     mScene.Discard();
 147   }
 148 }
 149
 150 void SceneHolder::Add( Dali::Actor actor )
 151 {
 152   if ( mScene )
 153   {
 154     mScene.Add( actor );
 155   }
 156 }
 157
 158 void SceneHolder::Remove( Dali::Actor actor )
 159 {
 160   if ( mScene )
 161   {
 162     mScene.Remove( actor );
 163   }
 164 }
 165
 166 Dali::Layer SceneHolder::GetRootLayer() const
 167 {
 168   return mScene ? mScene.GetRootLayer() : Dali::Layer();
 169 }
 170
 171 uint32_t SceneHolder::GetId() const
 172 {
 173   return mId;
 174 }
 175
 176 std::string SceneHolder::GetName() const
 177 {
 178   return mName;
 179 }
 180
 181 bool SceneHolder::IsVisible() const
 182 {
 183   return mVisible;
 184 }
 185
 186 Dali::Integration::Scene SceneHolder::GetScene()
 187 {
 188   return mScene;
 189 }
 190
 191 Uint16Pair SceneHolder::GetDpi() const
 192 {
 193   return mDpi;
 194 }
 195
 196 void SceneHolder::SetSurface(Dali::RenderSurfaceInterface* surface)
 197 {
 198   mSurface.reset( surface );
 199
 200   mScene.SurfaceReplaced();
 201
 202   SurfaceResized( false );
 203
 204   InitializeDpi();
 205
 206   mSurface->SetAdaptor( *mAdaptor );
 207   mSurface->SetScene( mScene );
 208
 209   OnSurfaceSet( surface );
 210 }
 211
 212 void SceneHolder::SurfaceResized( bool forceUpdate )
 213 {
 214   PositionSize surfacePositionSize = mSurface->GetPositionSize();
 215   int orientation = mSurface->GetOrientation();
 216   mScene.SurfaceResized( static_cast<float>( surfacePositionSize.width ), static_cast<float>( surfacePositionSize.height ), orientation, forceUpdate );
 217
 218   GraphicsInterface& graphics = mAdaptor->GetGraphicsInterface();
 219   EglGraphics* eglGraphics = static_cast<EglGraphics*>(&graphics);
 220   if (eglGraphics)
 221   {
 222     eglGraphics->SetFullSwapNextFrame();
 223   }
 224 }
 225
 226 Dali::RenderSurfaceInterface* SceneHolder::GetSurface() const
 227 {
 228   return mSurface.get();
 229 }
 230
 231 void SceneHolder::SetBackgroundColor( const Vector4& color )
 232 {
 233   if( mScene )
 234   {
 235     mScene.SetBackgroundColor( color );
 236
 237     GraphicsInterface& graphics = mAdaptor->GetGraphicsInterface();
 238     EglGraphics* eglGraphics = static_cast<EglGraphics*>(&graphics);
 239     if (eglGraphics)
 240     {
 241       eglGraphics->SetFullSwapNextFrame();
 242     }
 243   }
 244 }
 245
 246 Vector4 SceneHolder::GetBackgroundColor() const
 247 {
 248   return mScene ? mScene.GetBackgroundColor() : Color::BLACK;
 249 }
 250
 251 void SceneHolder::SetAdaptor(Dali::Adaptor& adaptor)
 252 {
 253   // Avoid doing this more than once
 254   if( mAdaptorStarted )
 255   {
 256     return;
 257   }
 258
 259   DALI_ASSERT_DEBUG(mSurface && "Surface needs to be set before calling this method\n");
 260
 261   mAdaptorStarted = true;
 262
 263   // Create the scene
 264   PositionSize surfacePositionSize = mSurface->GetPositionSize();
 265   int orientation = mSurface->GetOrientation();
 266   mScene = Dali::Integration::Scene::New( Size(static_cast<float>( surfacePositionSize.width ), static_cast<float>( surfacePositionSize.height )), orientation );
 267
 268   Internal::Adaptor::Adaptor& adaptorImpl = Internal::Adaptor::Adaptor::GetImplementation( adaptor );
 269   mAdaptor = &adaptorImpl;
 270
 271   // Create an observer for the adaptor lifecycle
 272   mAdaptor->AddObserver( *mLifeCycleObserver );
 273
 274   InitializeDpi();
 275
 276   mSurface->SetAdaptor( *mAdaptor );
 277   mSurface->SetScene( mScene );
 278
 279   OnAdaptorSet( adaptor );
 280 }
 281
 282 void SceneHolder::Pause()
 283 {
 284   Reset();
 285
 286   OnPause();
 287 }
 288
 289 void SceneHolder::Resume()
 290 {
 291   Reset();
 292
 293   OnResume();
 294 }
 295
 296 void SceneHolder::FeedTouchPoint( Dali::Integration::Point& point, int timeStamp )
 297 {
 298   if( timeStamp < 1 )
 299   {
 300     timeStamp = GetCurrentMilliSeconds();
 301   }
 302
 303   RecalculateTouchPosition( point );
 304
 305   Integration::TouchEvent touchEvent;
 306   Integration::HoverEvent hoverEvent;
 307   Integration::TouchEventCombiner::EventDispatchType type = mCombiner.GetNextTouchEvent(point, timeStamp, touchEvent, hoverEvent);
 308   if( type != Integration::TouchEventCombiner::DISPATCH_NONE )
 309   {
 310     DALI_LOG_INFO( gSceneHolderLogFilter, Debug::Verbose, "%d: Device %d: Button state %d (%.2f, %.2f)\n", timeStamp, point.GetDeviceId(), point.GetState(), point.GetScreenPosition().x, point.GetScreenPosition().y );
 311
 312     // Signals can be emitted while processing core events, and the scene holder could be deleted in the signal callback.
 313     // Keep the handle alive until the core events are processed.
 314     Dali::BaseHandle sceneHolder( this );
 315
 316     // First the touch and/or hover event & related gesture events are queued
 317     if( type == Integration::TouchEventCombiner::DISPATCH_TOUCH || type == Integration::TouchEventCombiner::DISPATCH_BOTH )
 318     {
 319       mScene.QueueEvent( touchEvent );
 320     }
 321
 322     if( type == Integration::TouchEventCombiner::DISPATCH_HOVER || type == Integration::TouchEventCombiner::DISPATCH_BOTH )
 323     {
 324       mScene.QueueEvent( hoverEvent );
 325     }
 326
 327     // Next the events are processed with a single call into Core
 328     mAdaptor->ProcessCoreEvents();
 329   }
 330 }
 331
 332 void SceneHolder::FeedWheelEvent( Dali::Integration::WheelEvent& wheelEvent )
 333 {
 334   // Signals can be emitted while processing core events, and the scene holder could be deleted in the signal callback.
 335   // Keep the handle alive until the core events are processed.
 336   Dali::BaseHandle sceneHolder( this );
 337
 338   mScene.QueueEvent( wheelEvent );
 339   mAdaptor->ProcessCoreEvents();
 340 }
 341
 342 void SceneHolder::FeedKeyEvent( Dali::Integration::KeyEvent& keyEvent )
 343 {
 344   Dali::PhysicalKeyboard physicalKeyboard = PhysicalKeyboard::Get();
 345   if( physicalKeyboard )
 346   {
 347     if( ! KeyLookup::IsDeviceButton( keyEvent.keyName.c_str() ) )
 348     {
 349       GetImplementation( physicalKeyboard ).KeyReceived( keyEvent.time > 1 );
 350     }
 351   }
 352
 353   // Signals can be emitted while processing core events, and the scene holder could be deleted in the signal callback.
 354   // Keep the handle alive until the core events are processed.
 355   Dali::BaseHandle sceneHolder( this );
 356
 357   // Create send KeyEvent to Core.
 358   mScene.QueueEvent( keyEvent );
 359   mAdaptor->ProcessCoreEvents();
 360 }
 361
 362 void SceneHolder::AddFrameRenderedCallback( std::unique_ptr< CallbackBase > callback, int32_t frameId )
 363 {
 364   mScene.AddFrameRenderedCallback( std::move( callback ), frameId );
 365
 366   DALI_LOG_INFO( gSceneHolderLogFilter, Debug::General, "SceneHolder::AddFrameRenderedCallback:: Added [%d]\n", frameId );
 367 }
 368
 369 void SceneHolder::AddFramePresentedCallback( std::unique_ptr< CallbackBase > callback, int32_t frameId )
 370 {
 371   mScene.AddFramePresentedCallback( std::move( callback ), frameId );
 372
 373   DALI_LOG_INFO( gSceneHolderLogFilter, Debug::General, "SceneHolder::AddFramePresentedCallback:: Added [%d]\n", frameId );
 374 }
 375
 376 Dali::Integration::SceneHolder SceneHolder::Get( Dali::Actor actor )
 377 {
 378   SceneHolder* sceneHolderImpl = nullptr;
 379
 380   if ( Internal::Adaptor::Adaptor::IsAvailable() )
 381   {
 382     Dali::Internal::Adaptor::Adaptor& adaptor = Internal::Adaptor::Adaptor::GetImplementation( Internal::Adaptor::Adaptor::Get() );
 383     sceneHolderImpl = adaptor.GetWindow( actor );
 384   }
 385
 386   return Dali::Integration::SceneHolder( sceneHolderImpl );
 387 }
 388
 389 void SceneHolder::Reset()
 390 {
 391   mCombiner.Reset();
 392
 393   // Any touch listeners should be told of the interruption.
 394   Integration::TouchEvent event;
 395   Integration::Point point;
 396   point.SetState( PointState::INTERRUPTED );
 397   event.AddPoint( point );
 398
 399   // First the touch event & related gesture events are queued
 400   mScene.QueueEvent( event );
 401
 402   // Next the events are processed with a single call into Core
 403   mAdaptor->ProcessCoreEvents();
 404 }
 405
 406 void SceneHolder::InitializeDpi()
 407 {
 408   unsigned int dpiHorizontal, dpiVertical;
 409   dpiHorizontal = dpiVertical = 0;
 410
 411   mSurface->GetDpi( dpiHorizontal, dpiVertical );
 412   mScene.SetDpi( Vector2( static_cast<float>( dpiHorizontal ), static_cast<float>( dpiVertical ) ) );
 413
 414   mDpi.SetX( dpiHorizontal );
 415   mDpi.SetY( dpiVertical );
 416 }
 417
 418 }// Adaptor
 419
 420 }// Internal
 421
 422 } // Dali