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/actors/actor.h>
  24 #include <dali/public-api/actors/layer.h>
  25 #include <dali/integration-api/debug.h>
  26 #include <dali/integration-api/events/key-event-integ.h>
  27 #include <dali/integration-api/events/touch-event-integ.h>
  28 #include <dali/integration-api/events/hover-event-integ.h>
  29 #include <dali/integration-api/events/wheel-event-integ.h>
  30
  31 // INTERNAL INCLUDES
  32 #include <dali/internal/adaptor/common/adaptor-impl.h>
  33 #include <dali/internal/adaptor/common/lifecycle-observer.h>
  34 #include <dali/internal/graphics/gles/egl-graphics.h>
  35 #include <dali/internal/input/common/key-impl.h>
  36 #include <dali/internal/input/common/physical-keyboard-impl.h>
  37
  38 namespace Dali
  39 {
  40
  41 namespace Internal
  42 {
  43
  44 namespace Adaptor
  45 {
  46
  47 namespace
  48 {
  49
  50 #if defined(DEBUG_ENABLED)
  51 Debug::Filter* gSceneHolderLogFilter = Debug::Filter::New( Debug::NoLogging, false, "LOG_SCENE_HOLDER" );
  52 #endif
  53
  54 // Copied from x server
  55 static uint32_t GetCurrentMilliSeconds(void)
  56 {
  57   struct timeval tv;
  58
  59   struct timespec tp;
  60   static clockid_t clockid;
  61
  62   if (!clockid)
  63   {
  64 #ifdef CLOCK_MONOTONIC_COARSE
  65     if (clock_getres(CLOCK_MONOTONIC_COARSE, &tp) == 0 &&
  66       (tp.tv_nsec / 1000) <= 1000 && clock_gettime(CLOCK_MONOTONIC_COARSE, &tp) == 0)
  67     {
  68       clockid = CLOCK_MONOTONIC_COARSE;
  69     }
  70     else
  71 #endif
  72     if (clock_gettime(CLOCK_MONOTONIC, &tp) == 0)
  73     {
  74       clockid = CLOCK_MONOTONIC;
  75     }
  76     else
  77     {
  78       clockid = ~0L;
  79     }
  80   }
  81   if (clockid != ~0L && clock_gettime(clockid, &tp) == 0)
  82   {
  83     return static_cast<uint32_t>( (tp.tv_sec * 1000 ) + (tp.tv_nsec / 1000000L) );
  84   }
  85
  86   gettimeofday(&tv, NULL);
  87   return static_cast<uint32_t>( (tv.tv_sec * 1000 ) + (tv.tv_usec / 1000) );
  88 }
  89
  90 } // unnamed namespace
  91
  92 uint32_t SceneHolder::mSceneHolderCounter = 0;
  93
  94 class SceneHolder::SceneHolderLifeCycleObserver : public LifeCycleObserver
  95 {
  96 public:
  97
  98   SceneHolderLifeCycleObserver(Adaptor*& adaptor)
  99   : mAdaptor( adaptor )
 100   {
 101   };
 102
 103 private: // Adaptor::LifeCycleObserver interface
 104
 105   void OnStart() override {};
 106   void OnPause() override {};
 107   void OnResume() override {};
 108   void OnStop() override {};
 109   void OnDestroy() override
 110   {
 111     mAdaptor = nullptr;
 112   };
 113
 114 private:
 115   Adaptor*& mAdaptor;
 116 };
 117
 118
 119 SceneHolder::SceneHolder()
 120 : mLifeCycleObserver( new SceneHolderLifeCycleObserver( mAdaptor ) ),
 121   mId( mSceneHolderCounter++ ),
 122   mSurface( nullptr ),
 123   mAdaptor( nullptr ),
 124   mIsBeingDeleted( false ),
 125   mAdaptorStarted( false ),
 126   mVisible( true )
 127 {
 128 }
 129
 130 SceneHolder::~SceneHolder()
 131 {
 132   if ( mAdaptor )
 133   {
 134     mAdaptor->RemoveObserver( *mLifeCycleObserver.get() );
 135     mAdaptor->RemoveWindow( this );
 136
 137     mAdaptor->DeleteSurface( *mSurface.get() );
 138
 139     mAdaptor = nullptr;
 140   }
 141
 142   if ( mScene )
 143   {
 144     mScene.Discard();
 145   }
 146 }
 147
 148 void SceneHolder::Add( Dali::Actor actor )
 149 {
 150   if ( mScene )
 151   {
 152     mScene.Add( actor );
 153   }
 154 }
 155
 156 void SceneHolder::Remove( Dali::Actor actor )
 157 {
 158   if ( mScene )
 159   {
 160     mScene.Remove( actor );
 161   }
 162 }
 163
 164 Dali::Layer SceneHolder::GetRootLayer() const
 165 {
 166   return mScene ? mScene.GetRootLayer() : Dali::Layer();
 167 }
 168
 169 uint32_t SceneHolder::GetId() const
 170 {
 171   return mId;
 172 }
 173
 174 std::string SceneHolder::GetName() const
 175 {
 176   return mName;
 177 }
 178
 179 bool SceneHolder::IsVisible() const
 180 {
 181   return mVisible;
 182 }
 183
 184 Dali::Integration::Scene SceneHolder::GetScene()
 185 {
 186   return mScene;
 187 }
 188
 189 void SceneHolder::SetSurface(Dali::RenderSurfaceInterface* surface)
 190 {
 191   mSurface.reset( surface );
 192
 193   mScene.SurfaceReplaced();
 194
 195   SurfaceResized();
 196
 197   unsigned int dpiHorizontal, dpiVertical;
 198   dpiHorizontal = dpiVertical = 0;
 199
 200   mSurface->GetDpi( dpiHorizontal, dpiVertical );
 201   mScene.SetDpi( Vector2( static_cast<float>( dpiHorizontal ), static_cast<float>( dpiVertical ) ) );
 202
 203   mSurface->SetAdaptor( *mAdaptor );
 204   mSurface->SetScene( mScene );
 205
 206   OnSurfaceSet( surface );
 207 }
 208
 209 void SceneHolder::SurfaceResized()
 210 {
 211   PositionSize surfacePositionSize = mSurface->GetPositionSize();
 212   mScene.SurfaceResized( static_cast<float>( surfacePositionSize.width ), static_cast<float>( surfacePositionSize.height ) );
 213
 214   GraphicsInterface& graphics = mAdaptor->GetGraphicsInterface();
 215   EglGraphics* eglGraphics = static_cast<EglGraphics*>(&graphics);
 216   if (eglGraphics)
 217   {
 218     eglGraphics->SetFullSwapNextFrame();
 219   }
 220 }
 221
 222 Dali::RenderSurfaceInterface* SceneHolder::GetSurface() const
 223 {
 224   return mSurface.get();
 225 }
 226
 227 void SceneHolder::SetBackgroundColor( const Vector4& color )
 228 {
 229   if( mScene )
 230   {
 231     mScene.SetBackgroundColor( color );
 232
 233     GraphicsInterface& graphics = mAdaptor->GetGraphicsInterface();
 234     EglGraphics* eglGraphics = static_cast<EglGraphics*>(&graphics);
 235     if (eglGraphics)
 236     {
 237       eglGraphics->SetFullSwapNextFrame();
 238     }
 239   }
 240 }
 241
 242 Vector4 SceneHolder::GetBackgroundColor() const
 243 {
 244   return mScene ? mScene.GetBackgroundColor() : Color::BLACK;
 245 }
 246
 247 void SceneHolder::SetAdaptor(Dali::Adaptor& adaptor)
 248 {
 249   // Avoid doing this more than once
 250   if( mAdaptorStarted )
 251   {
 252     return;
 253   }
 254
 255   mAdaptorStarted = true;
 256
 257   // Create the scene
 258   PositionSize surfacePositionSize = mSurface->GetPositionSize();
 259   mScene = Dali::Integration::Scene::New( Size(static_cast<float>( surfacePositionSize.width ), static_cast<float>( surfacePositionSize.height )) );
 260
 261   Internal::Adaptor::Adaptor& adaptorImpl = Internal::Adaptor::Adaptor::GetImplementation( adaptor );
 262   mAdaptor = &adaptorImpl;
 263
 264   // Create an observer for the adaptor lifecycle
 265   mAdaptor->AddObserver( *mLifeCycleObserver );
 266
 267   if ( mSurface )
 268   {
 269     unsigned int dpiHorizontal, dpiVertical;
 270     dpiHorizontal = dpiVertical = 0;
 271
 272     mSurface->GetDpi( dpiHorizontal, dpiVertical );
 273     mScene.SetDpi( Vector2( static_cast<float>( dpiHorizontal ), static_cast<float>( dpiVertical ) ) );
 274
 275     mSurface->SetAdaptor( *mAdaptor );
 276     mSurface->SetScene( mScene );
 277   }
 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::DispatchNone )
 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::DispatchTouch || type == Integration::TouchEventCombiner::DispatchBoth )
 318     {
 319       mScene.QueueEvent( touchEvent );
 320     }
 321
 322     if( type == Integration::TouchEventCombiner::DispatchHover || type == Integration::TouchEventCombiner::DispatchBoth )
 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
 407 }// Adaptor
 408
 409 }// Internal
 410
 411 } // Dali