(Partial update) Fix surface damage area
[platform/core/uifw/dali-adaptor.git] / dali / internal / graphics / gles / egl-implementation.cpp
index 68d7925..6e39644 100755 (executable)
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2019 Samsung Electronics Co., Ltd.
+ * Copyright (c) 2020 Samsung Electronics Co., Ltd.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -35,6 +35,7 @@
 
 namespace
 {
+  const uint32_t THRESHOLD_SWAPBUFFER_COUNT = 5;
   const uint32_t CHECK_EXTENSION_NUMBER = 2;
   const std::string EGL_KHR_SURFACELESS_CONTEXT = "EGL_KHR_surfaceless_context";
   const std::string EGL_KHR_CREATE_CONTEXT = "EGL_KHR_create_context";
@@ -62,7 +63,8 @@ namespace Adaptor
 
 EglImplementation::EglImplementation( int multiSamplingLevel,
                                       Integration::DepthBufferAvailable depthBufferRequired,
-                                      Integration::StencilBufferAvailable stencilBufferRequired )
+                                      Integration::StencilBufferAvailable stencilBufferRequired ,
+                                      Integration::PartialUpdateAvailable partialUpdateRequired )
 : mContextAttribs(),
   mEglNativeDisplay( 0 ),
   mEglNativeWindow( 0 ),
@@ -80,8 +82,13 @@ EglImplementation::EglImplementation( int multiSamplingLevel,
   mIsWindow( true ),
   mDepthBufferRequired( depthBufferRequired == Integration::DepthBufferAvailable::TRUE ),
   mStencilBufferRequired( stencilBufferRequired == Integration::StencilBufferAvailable::TRUE ),
+  mPartialUpdateRequired( partialUpdateRequired == Integration::PartialUpdateAvailable::TRUE ),
   mIsSurfacelessContextSupported( false ),
-  mIsKhrCreateContextSupported( false )
+  mIsKhrCreateContextSupported( false ),
+  mSwapBufferCountAfterResume( 0 ),
+  mEglSetDamageRegionKHR( 0 ),
+  mEglSwapBuffersWithDamageKHR( 0 ),
+  mFullSwapNextFrame( true )
 {
 }
 
@@ -96,12 +103,18 @@ bool EglImplementation::InitializeGles( EGLNativeDisplayType display, bool isOwn
   {
     mEglNativeDisplay = display;
 
-    //@todo see if we can just EGL_DEFAULT_DISPLAY instead
-    mEglDisplay = eglGetDisplay(mEglNativeDisplay);
-    EGLint error = eglGetError();
+    // Try to get the display connection for the native display first
+    mEglDisplay = eglGetDisplay( mEglNativeDisplay );
 
-    if( mEglDisplay == NULL && error != EGL_SUCCESS )
+    if( mEglDisplay == EGL_NO_DISPLAY )
     {
+      // If failed, try to get the default display connection
+      mEglDisplay = eglGetDisplay( EGL_DEFAULT_DISPLAY );
+    }
+
+    if( mEglDisplay == EGL_NO_DISPLAY )
+    {
+      // Still failed to get a display connection
       throw Dali::DaliException( "", "OpenGL ES is not supported");
     }
 
@@ -113,7 +126,6 @@ bool EglImplementation::InitializeGles( EGLNativeDisplayType display, bool isOwn
     }
     eglBindAPI(EGL_OPENGL_ES_API);
 
-    mGlesInitialized = true;
     mIsOwnSurface = isOwnSurface;
   }
 
@@ -136,12 +148,16 @@ bool EglImplementation::InitializeGles( EGLNativeDisplayType display, bool isOwn
     }
   }
 
+  mGlesInitialized = true;
+
   // We want to display this information all the time, so use the LogMessage directly
   Integration::Log::LogMessage(Integration::Log::DebugInfo, "EGL Information\n"
+      "            PartialUpdate  %d\n"
       "            Vendor:        %s\n"
       "            Version:       %s\n"
       "            Client APIs:   %s\n"
       "            Extensions:    %s\n",
+      mPartialUpdateRequired,
       eglQueryString( mEglDisplay, EGL_VENDOR ),
       eglQueryString( mEglDisplay, EGL_VERSION ),
       eglQueryString( mEglDisplay, EGL_CLIENT_APIS ),
@@ -166,6 +182,18 @@ bool EglImplementation::CreateContext()
   DALI_LOG_INFO(Debug::Filter::gShader, Debug::General, "*** GL_SHADING_LANGUAGE_VERSION : %s***\n", glGetString(GL_SHADING_LANGUAGE_VERSION));
   DALI_LOG_INFO(Debug::Filter::gShader, Debug::General, "*** Supported Extensions ***\n%s\n\n", glGetString(GL_EXTENSIONS));
 
+  mEglSetDamageRegionKHR = reinterpret_cast<PFNEGLSETDAMAGEREGIONKHRPROC>(eglGetProcAddress("eglSetDamageRegionKHR"));
+  if (!mEglSetDamageRegionKHR)
+  {
+    DALI_LOG_ERROR("Coudn't find eglSetDamageRegionKHR!\n");
+    mPartialUpdateRequired = false;
+  }
+  mEglSwapBuffersWithDamageKHR = reinterpret_cast<PFNEGLSWAPBUFFERSWITHDAMAGEEXTPROC>(eglGetProcAddress("eglSwapBuffersWithDamageKHR"));
+  if (!mEglSwapBuffersWithDamageKHR)
+  {
+    DALI_LOG_ERROR("Coudn't find eglSwapBuffersWithDamageKHR!\n");
+    mPartialUpdateRequired = false;
+  }
   return true;
 }
 
@@ -187,15 +215,28 @@ bool EglImplementation::CreateWindowContext( EGLContext& eglContext )
 
   mEglWindowContexts.push_back( eglContext );
 
+  mEglSetDamageRegionKHR = reinterpret_cast<PFNEGLSETDAMAGEREGIONKHRPROC>(eglGetProcAddress("eglSetDamageRegionKHR"));
+  if (!mEglSetDamageRegionKHR)
+  {
+    DALI_LOG_ERROR("Coudn't find eglSetDamageRegionKHR!\n");
+    mPartialUpdateRequired = false;
+  }
+  mEglSwapBuffersWithDamageKHR = reinterpret_cast<PFNEGLSWAPBUFFERSWITHDAMAGEEXTPROC>(eglGetProcAddress("eglSwapBuffersWithDamageKHR"));
+  if (!mEglSwapBuffersWithDamageKHR)
+  {
+    DALI_LOG_ERROR("Coudn't find eglSwapBuffersWithDamageKHR!\n");
+    mPartialUpdateRequired = false;
+  }
   return true;
 }
 
 void EglImplementation::DestroyContext( EGLContext& eglContext )
 {
-  DALI_ASSERT_ALWAYS( mEglContext && "no EGL context" );
-
-  eglDestroyContext( mEglDisplay, eglContext );
-  eglContext = 0;
+  if( eglContext )
+  {
+    eglDestroyContext( mEglDisplay, eglContext );
+    eglContext = 0;
+  }
 }
 
 void EglImplementation::DestroySurface( EGLSurface& eglSurface )
@@ -220,11 +261,6 @@ void EglImplementation::MakeContextCurrent( EGLSurface eglSurface, EGLContext eg
 
   if(mIsOwnSurface)
   {
-    if( mCurrentEglContext != EGL_NO_CONTEXT )
-    {
-      glFinish();
-    }
-
     eglMakeCurrent( mEglDisplay, eglSurface, eglSurface, eglContext );
 
     mCurrentEglContext = eglContext;
@@ -252,11 +288,6 @@ void EglImplementation::MakeCurrent( EGLNativePixmapType pixmap, EGLSurface eglS
 
   if(mIsOwnSurface)
   {
-    if( mCurrentEglContext != EGL_NO_CONTEXT )
-    {
-      glFinish();
-    }
-
     eglMakeCurrent( mEglDisplay, eglSurface, eglSurface, mEglContext );
 
     mCurrentEglContext = mEglContext;
@@ -320,7 +351,223 @@ void EglImplementation::SwapBuffers( EGLSurface& eglSurface )
 {
   if ( eglSurface != EGL_NO_SURFACE ) // skip if using surfaceless context
   {
+#ifndef DALI_PROFILE_UBUNTU
+    if( mSwapBufferCountAfterResume < THRESHOLD_SWAPBUFFER_COUNT )
+    {
+      DALI_LOG_RELEASE_INFO( "EglImplementation::SwapBuffers started.\n" );
+    }
+#endif //DALI_PROFILE_UBUNTU
+
+    // DALI_LOG_ERROR("EglImplementation::SwapBuffers()\n");
     eglSwapBuffers( mEglDisplay, eglSurface );
+    mFullSwapNextFrame = false;
+
+#ifndef DALI_PROFILE_UBUNTU
+    if( mSwapBufferCountAfterResume < THRESHOLD_SWAPBUFFER_COUNT )
+    {
+      DALI_LOG_RELEASE_INFO( "EglImplementation::SwapBuffers finished.\n" );
+      mSwapBufferCountAfterResume++;
+    }
+#endif //DALI_PROFILE_UBUNTU
+  }
+}
+
+EGLint EglImplementation::GetBufferAge(EGLSurface& eglSurface) const
+{
+  EGLint age = 0;
+  eglQuerySurface(mEglDisplay, eglSurface, EGL_BUFFER_AGE_EXT, &age);
+  if (age < 0)
+  {
+    DALI_LOG_ERROR("eglQuerySurface(%d)\n", eglGetError());
+    age = 0;
+  }
+
+  // 0 - invalid buffer
+  // 1, 2, 3
+  if (age > 3)
+  {
+    DALI_LOG_ERROR("EglImplementation::GetBufferAge() buffer age %d > 3\n", age);
+    age = 0; // shoudn't be more than 3 back buffers, if there is just reset, I don't want to add extra history level
+  }
+
+  return age;
+}
+
+void EglImplementation::SetFullSwapNextFrame()
+{
+  mFullSwapNextFrame = true;
+}
+
+void mergeRects(Rect<int>& mergingRect, const std::vector<Rect<int>>& rects)
+{
+  uint32_t i = 0;
+  if (mergingRect.IsEmpty())
+  {
+    for (;i < rects.size(); i++)
+    {
+      if (!rects[i].IsEmpty())
+      {
+        mergingRect = rects[i];
+        break;
+      }
+    }
+  }
+
+  for (;i < rects.size(); i++)
+  {
+    mergingRect.Merge(rects[i]);
+  }
+}
+
+void insertRects(std::list<std::vector<Rect<int>>>& damagedRectsList, const std::vector<Rect<int>>& damagedRects)
+{
+  damagedRectsList.push_front(damagedRects);
+  if (damagedRectsList.size() > 4) // past triple buffers + current
+  {
+    damagedRectsList.pop_back();
+  }
+}
+
+void EglImplementation::SetDamage( EGLSurface& eglSurface, const std::vector<Rect<int>>& damagedRects, Rect<int>& clippingRect )
+{
+  if (!mPartialUpdateRequired)
+  {
+    return;
+  }
+
+  if (eglSurface != EGL_NO_SURFACE) // skip if using surfaceless context
+  {
+    EGLint width = 0;
+    EGLint height = 0;
+    eglQuerySurface(mEglDisplay, eglSurface, EGL_WIDTH, &width);
+    eglQuerySurface(mEglDisplay, eglSurface, EGL_HEIGHT, &height);
+    Rect<int> surfaceRect(0, 0, width, height);
+
+    mSurfaceRect = surfaceRect;
+
+    if (mFullSwapNextFrame)
+    {
+      insertRects(mBufferDamagedRects, std::vector<Rect<int>>(1, surfaceRect));
+      clippingRect = Rect<int>();
+      return;
+    }
+
+    EGLint bufferAge = GetBufferAge(eglSurface);
+
+    // Buffer age 0 means the back buffer in invalid and requires full swap
+    if (!damagedRects.size() || bufferAge == 0)
+    {
+      // No damage or buffer is out of order or buffer age is reset
+      insertRects(mBufferDamagedRects, std::vector<Rect<int>>(1, surfaceRect));
+      clippingRect = Rect<int>();
+      return;
+    }
+
+    // We push current frame damaged rects here, zero index for current frame
+    insertRects(mBufferDamagedRects, damagedRects);
+
+    // Merge damaged rects into clipping rect
+    auto bufferDamagedRects = mBufferDamagedRects.begin();
+    while (bufferAge-- >= 0 && bufferDamagedRects != mBufferDamagedRects.end())
+    {
+      const std::vector<Rect<int>>& rects = *bufferDamagedRects++;
+      mergeRects(clippingRect, rects);
+    }
+
+    if (!clippingRect.Intersect(surfaceRect) || clippingRect.Area() > surfaceRect.Area() * 0.8)
+    {
+      // clipping area too big or doesn't intersect surface rect
+      clippingRect = Rect<int>();
+      return;
+    }
+
+    // DALI_LOG_ERROR("eglSetDamageRegionKHR(%d, %d, %d, %d)\n", clippingRect.x, clippingRect.y, clippingRect.width, clippingRect.height);
+    EGLBoolean result = mEglSetDamageRegionKHR(mEglDisplay, eglSurface, reinterpret_cast<int*>(&clippingRect), 1);
+    if (result == EGL_FALSE)
+    {
+      DALI_LOG_ERROR("eglSetDamageRegionKHR(%d)\n", eglGetError());
+    }
+  }
+}
+
+void EglImplementation::SwapBuffers(EGLSurface& eglSurface, const std::vector<Rect<int>>& damagedRects)
+{
+  if (eglSurface != EGL_NO_SURFACE ) // skip if using surfaceless context
+  {
+    if (!mPartialUpdateRequired || mFullSwapNextFrame || !damagedRects.size() || (damagedRects[0].Area() > mSurfaceRect.Area() * 0.8) )
+    {
+      SwapBuffers(eglSurface);
+      return;
+    }
+
+#ifndef DALI_PROFILE_UBUNTU
+    if( mSwapBufferCountAfterResume < THRESHOLD_SWAPBUFFER_COUNT )
+    {
+      DALI_LOG_RELEASE_INFO( "EglImplementation::SwapBuffers started.\n" );
+    }
+#endif //DALI_PROFILE_UBUNTU
+
+    std::vector< Rect< int > > mergedRects = damagedRects;
+
+    // Merge intersecting rects, form an array of non intersecting rects to help driver a bit
+    // Could be optional and can be removed, needs to be checked with and without on platform
+    const int n = mergedRects.size();
+    for(int i = 0; i < n-1; i++)
+    {
+      if (mergedRects[i].IsEmpty())
+      {
+        continue;
+      }
+
+      for (int j = i+1; j < n; j++)
+      {
+        if (mergedRects[j].IsEmpty())
+        {
+          continue;
+        }
+
+        if (mergedRects[i].Intersects(mergedRects[j]))
+        {
+          mergedRects[i].Merge(mergedRects[j]);
+          mergedRects[j].width = 0;
+          mergedRects[j].height = 0;
+        }
+      }
+    }
+
+    int j = 0;
+    for (int i = 0; i < n; i++)
+    {
+      if (!mergedRects[i].IsEmpty())
+      {
+        mergedRects[j++] = mergedRects[i];
+      }
+    }
+
+    if (j != 0)
+    {
+      mergedRects.resize(j);
+    }
+
+    if (!mergedRects.size() || (mergedRects[0].Area() > mSurfaceRect.Area() * 0.8))
+    {
+      SwapBuffers(eglSurface);
+      return;
+    }
+
+    EGLBoolean result = mEglSwapBuffersWithDamageKHR(mEglDisplay, eglSurface, reinterpret_cast<int*>(mergedRects.data()), mergedRects.size());
+    if (result == EGL_FALSE)
+    {
+      DALI_LOG_ERROR("eglSwapBuffersWithDamageKHR(%d)\n", eglGetError());
+    }
+
+#ifndef DALI_PROFILE_UBUNTU
+    if( mSwapBufferCountAfterResume < THRESHOLD_SWAPBUFFER_COUNT )
+    {
+      DALI_LOG_RELEASE_INFO( "EglImplementation::SwapBuffers finished.\n" );
+      mSwapBufferCountAfterResume++;
+    }
+#endif //DALI_PROFILE_UBUNTU
   }
 }
 
@@ -341,8 +588,6 @@ bool EglImplementation::ChooseConfig( bool isWindowType, ColorDepth depth )
     return true;
   }
 
-  bool isTransparent = ( depth == COLOR_DEPTH_32 );
-
   mColorDepth = depth;
   mIsWindow = isWindowType;
 
@@ -383,18 +628,9 @@ bool EglImplementation::ChooseConfig( bool isWindowType, ColorDepth depth )
   configAttribs.PushBack( EGL_BLUE_SIZE );
   configAttribs.PushBack( 8 );
 
-  if ( isTransparent )
-  {
-    configAttribs.PushBack( EGL_ALPHA_SIZE );
-#ifdef _ARCH_ARM_
-    // For underlay video playback, we also need to set the alpha value of the 24/32bit window.
-    configAttribs.PushBack( 8 );
-#else
-    // There is a bug in the desktop emulator
-    // setting EGL_ALPHA_SIZE to 8 results in eglChooseConfig failing
-    configAttribs.PushBack( 8 );
-#endif // _ARCH_ARM_
-  }
+//  For underlay video playback, we also need to set the alpha value of the 24/32bit window.
+  configAttribs.PushBack( EGL_ALPHA_SIZE );
+  configAttribs.PushBack( 8 );
 
   configAttribs.PushBack( EGL_DEPTH_SIZE );
   configAttribs.PushBack( mDepthBufferRequired ? 24 : 0 );
@@ -526,8 +762,11 @@ bool EglImplementation::ReplaceSurfaceWindow( EGLNativeWindowType window, EGLSur
   //  the surface is bound to the context, so set the context to null
   MakeContextNull();
 
-  // destroy the surface
-  DestroySurface( eglSurface );
+  if( eglSurface )
+  {
+    // destroy the surface
+    DestroySurface( eglSurface );
+  }
 
   // create the EGL surface
   EGLSurface newEglSurface = CreateSurfaceWindow( window, mColorDepth );
@@ -557,6 +796,11 @@ void EglImplementation::SetGlesVersion( const int32_t glesVersion )
   mGlesVersion = glesVersion;
 }
 
+void EglImplementation::SetFirstFrameAfterResume()
+{
+  mSwapBufferCountAfterResume = 0;
+}
+
 EGLDisplay EglImplementation::GetDisplay() const
 {
   return mEglDisplay;
@@ -577,6 +821,15 @@ bool EglImplementation::IsSurfacelessContextSupported() const
   return mIsSurfacelessContextSupported;
 }
 
+void EglImplementation::WaitClient()
+{
+  // Wait for EGL to finish executing all rendering calls for the current context
+  if ( eglWaitClient() != EGL_TRUE )
+  {
+    TEST_EGL_ERROR("eglWaitClient");
+  }
+}
+
 } // namespace Adaptor
 
 } // namespace Internal