Merge lp:~3v1n0/unity/scale-decoration-cache into lp:unity

[Marco Trevisan (Treviño)]

UnityWindow: when spreading, render once an empty decoration texture at full size and scale it via OpenGL

This saves a lot of drawing and improves the performances of the unity Spread. Also, don't redraw the decoration texture for selected windows if not needed.
Finally, cleanup the header file

Unity was always redrawing the decoration textures at every compiz gldraw iteration, and this lead to a slowdown especially when we had a lot of windows to decorate.

I've changed this approach completely, now:
 - All the scaled windows cache a full-size decoration with no title when the spread
   begins, then we always draw that decoration using a scaled matrix (this avoids all
   the cairo stuff at every iteration).

 - The selected scaled window decoration is redrawn everytime its geometry has changed or
   the title has changed.

[Brandon Schaefer (brandontschaefer)]

What an improvement! Looks good, and is a lot faster! +1

No tests as all the features are already covered, this is about caching textures (which if this caused a problem the test we already have would catch it!)

review: Approve

=== modified file 'plugins/unityshell/src/unityshell.cpp'
--- plugins/unityshell/src/unityshell.cpp	2012-09-24 15:22:57 +0000
+++ plugins/unityshell/src/unityshell.cpp	2012-09-24 18:46:21 +0000
@@ -87,9 +87,6 @@
 
 UnityScreen* uScreen = 0;
 
-const unsigned int SCALE_CLOSE_ICON_SIZE = 19;
-const unsigned int SCALE_ITEMS_PADDING = 5;
-
 void reset_glib_logging();
 void configure_logging();
 void capture_g_log_calls(const gchar* log_domain,
@@ -111,8 +108,8 @@
 } // anon namespace
 
 UnityScreen::UnityScreen(CompScreen* screen)
-  : BaseSwitchScreen (screen)
-  , PluginClassHandler <UnityScreen, CompScreen> (screen)
+  : BaseSwitchScreen(screen)
+  , PluginClassHandler <UnityScreen, CompScreen>(screen)
   , screen(screen)
   , cScreen(CompositeScreen::get(screen))
   , gScreen(GLScreen::get(screen))
@@ -669,7 +666,12 @@
   UnityWindow::CleanupSharedTextures();
 
   if (WindowManager::Default()->IsScaleActive())
+  {
     UnityWindow::SetupSharedTextures();
+
+    for (auto const& swin : ScaleScreen::get(screen)->getWindows())
+      UnityWindow::get(swin->window)->CleanupCachedTextures();
+  }
 }
 
 void UnityScreen::paintDisplay()
@@ -3380,11 +3382,23 @@
 GLTexture::List UnityWindow::close_prelight_tex_;
 GLTexture::List UnityWindow::close_pressed_tex_;
 
+namespace scale
+{
+namespace decoration
+{
+const unsigned CLOSE_SIZE = 19;
+const unsigned ITEMS_PADDING = 5;
+const unsigned RADIUS = 8;
+}
+}
+
 struct UnityWindow::CairoContext
 {
-  CairoContext(int width, int height)
-    : pixmap_(XCreatePixmap(screen->dpy(), screen->root(), width, height, 32))
-    , texture_(GLTexture::bindPixmapToTexture(pixmap_, width, height, 32))
+  CairoContext(unsigned width, unsigned height)
+    : w_(width)
+    , h_(height)
+    , pixmap_(XCreatePixmap(screen->dpy(), screen->root(), w_, h_, 32))
+    , texture_(GLTexture::bindPixmapToTexture(pixmap_, w_, h_, 32))
     , surface_(nullptr)
     , cr_(nullptr)
   {
@@ -3406,7 +3420,7 @@
       cairo_restore(cr_);
   }
 
-  ~CairoContext ()
+  ~CairoContext()
   {
     if (cr_)
       cairo_destroy(cr_);
@@ -3414,12 +3428,12 @@
     if (surface_)
       cairo_surface_destroy(surface_);
 
-    texture_.clear();
-
     if (pixmap_)
-      XFreePixmap(screen->dpy (), pixmap_);
+      XFreePixmap(screen->dpy(), pixmap_);
   }
 
+  unsigned w_;
+  unsigned h_;
   Pixmap pixmap_;
   GLTexture::List texture_;
   cairo_surface_t* surface_;
@@ -3478,8 +3492,8 @@
     }
   }
 
-  WindowManager::Default()->initiate_spread.connect(sigc::mem_fun(this, &UnityWindow::OnInitiateSpreed));
-  WindowManager::Default()->terminate_spread.connect(sigc::mem_fun(this, &UnityWindow::OnTerminateSpreed));
+  WindowManager::Default()->initiate_spread.connect(sigc::mem_fun(this, &UnityWindow::OnInitiateSpread));
+  WindowManager::Default()->terminate_spread.connect(sigc::mem_fun(this, &UnityWindow::OnTerminateSpread));
 }
 
 void UnityWindow::AddProperties(GVariantBuilder* builder)
@@ -3505,8 +3519,9 @@
   return "Window";
 }
 
+
 void UnityWindow::DrawTexture(GLTexture::List const& textures, GLWindowPaintAttrib const& attrib,
-                              GLMatrix const& transform, unsigned int mask, int x, int y)
+                              GLMatrix const& transform, unsigned int mask, int x, int y, double scale)
 {
   for (auto const& texture : textures)
   {
@@ -3527,12 +3542,40 @@
     {
       GLMatrix wTransform(transform);
       wTransform.translate(x, y, 0.0f);
+      wTransform.scale(scale, scale, 1.0f);
 
       gWindow->glDrawTexture(texture, wTransform, attrib, mask);
     }
   }
 }
 
+void UnityWindow::RenderDecoration(CairoContext const& context, double aspect)
+{
+  cairo_save(context.cr_);
+
+  // Draw window decoration based on gtk style
+  cairo_push_group(context.cr_);
+  auto& style = panel::Style::Instance();
+  gtk_render_background(style.GetStyleContext(), context.cr_, 0, 0, context.w_, context.h_);
+  gtk_render_frame(style.GetStyleContext(), context.cr_, 0, 0, context.w_, context.h_);
+  cairo_pop_group_to_source(context.cr_);
+
+  // Round window decoration top border
+  const double radius = scale::decoration::RADIUS * aspect;
+
+  cairo_new_sub_path(context.cr_);
+  cairo_line_to(context.cr_, 0, context.h_);
+  cairo_arc(context.cr_, radius, radius, radius, M_PI, -M_PI * 0.5f);
+  cairo_line_to(context.cr_, context.w_ - radius, 0);
+  cairo_arc(context.cr_, context.w_ - radius, radius, radius, M_PI * 0.5f, 0);
+  cairo_line_to(context.cr_, context.w_, context.h_);
+  cairo_close_path(context.cr_);
+
+  cairo_fill(context.cr_);
+
+  cairo_restore(context.cr_);
+}
+
 void UnityWindow::RenderText(CairoContext const& context, int x, int y, int width, int height)
 {
   panel::Style& style = panel::Style::Instance();
@@ -3552,11 +3595,11 @@
   pango_cairo_context_set_resolution(pango_ctx, dpi / static_cast<float>(PANGO_SCALE));
   pango_layout_context_changed(layout);
 
-  std::string const& win_title = WindowManager::Default()->GetWindowName(window->id());
+  decoration_title_ = WindowManager::Default()->GetWindowName(window->id());
   pango_layout_set_height(layout, height);
   pango_layout_set_width(layout, -1); //avoid wrap lines
   pango_layout_set_auto_dir(layout, false);
-  pango_layout_set_text(layout, win_title.c_str(), -1);
+  pango_layout_set_text(layout, decoration_title_.c_str(), -1);
 
   /* update the size of the pango layout */
   pango_cairo_update_layout(context.cr_, layout);
@@ -3578,8 +3621,8 @@
   pango_layout_get_extents(layout, nullptr, &lRect);
   int text_width = lRect.width / PANGO_SCALE;
   int text_height = lRect.height / PANGO_SCALE;
+  int text_space = width - x;
   y += (height - text_height) / 2.0f;
-  int text_space = width - x;
 
   if (text_width > text_space)
   {
@@ -3606,49 +3649,19 @@
   gtk_style_context_restore(style_context);
 }
 
-void UnityWindow::DrawWindowDecoration(GLWindowPaintAttrib const& attrib,
-                                       GLMatrix const& transform,
-                                       unsigned int mask,
-                                       bool highlighted,
-                                       int x, int y, unsigned width, unsigned height)
+void UnityWindow::BuildDecorationTexture()
 {
-  // Paint a fake window decoration
-  CairoContext context(width, height);
-
-  cairo_save(context.cr_);
-
-  // Draw window decoration based on gtk style
-  cairo_push_group(context.cr_);
-  auto& style = panel::Style::Instance();
-  gtk_render_background(style.GetStyleContext(), context.cr_, 0, 0, width, height);
-  gtk_render_frame(style.GetStyleContext(), context.cr_, 0, 0, width, height);
-  cairo_pop_group_to_source(context.cr_);
-
-  // Round window decoration top border
-  const double aspect = ScaleWindow::get(window)->getCurrentPosition().scale;
-  const double radius = 8.0 * aspect;
-
-  cairo_new_sub_path(context.cr_);
-  cairo_line_to(context.cr_, 0, height);
-  cairo_arc(context.cr_, radius, radius, radius, M_PI, -M_PI * 0.5f);
-  cairo_line_to(context.cr_, width - radius, 0);
-  cairo_arc(context.cr_, width - radius, radius, radius, M_PI * 0.5f, 0);
-  cairo_line_to(context.cr_, width, height);
-  cairo_close_path(context.cr_);
-
-  cairo_fill(context.cr_);
-
-  cairo_restore(context.cr_);
-
-  if (highlighted)
+  if (!decoration_tex_.empty())
+    return;
+
+  auto const& border_extents = window->border();
+
+  if (WindowManager::Default()->IsWindowDecorated(window->id()) && border_extents.top > 0)
   {
-    // Draw windows title
-    const float xText = SCALE_ITEMS_PADDING * 2 + SCALE_CLOSE_ICON_SIZE;
-    RenderText(context, xText, 0.0, width - SCALE_ITEMS_PADDING, height);
+    CairoContext context(window->borderRect().width(), border_extents.top);
+    RenderDecoration(context);
+    decoration_tex_ = context.texture_;
   }
-
-  mask |= PAINT_WINDOW_BLEND_MASK;
-  DrawTexture(context.texture_, attrib, transform, mask, x, y);
 }
 
 void UnityWindow::LoadCloseIcon(panel::WindowState state, GLTexture::List& texture)
@@ -3663,7 +3676,7 @@
   for (std::string const& file : files)
   {
     CompString file_name = file;
-    CompSize size(SCALE_CLOSE_ICON_SIZE, SCALE_CLOSE_ICON_SIZE);
+    CompSize size(scale::decoration::CLOSE_SIZE, scale::decoration::CLOSE_SIZE);
     texture = GLTexture::readImageToTexture(file_name, plugin, size);
     if (!texture.empty())
       break;
@@ -3678,7 +3691,7 @@
       suffix = "_pressed";
 
     CompString file_name(PKGDATADIR"/close_dash" + suffix + ".png");
-    CompSize size(SCALE_CLOSE_ICON_SIZE, SCALE_CLOSE_ICON_SIZE);
+    CompSize size(scale::decoration::CLOSE_SIZE, scale::decoration::CLOSE_SIZE);
     texture = GLTexture::readImageToTexture(file_name, plugin, size);
   }
 }
@@ -3697,6 +3710,13 @@
   close_pressed_tex_.clear();
 }
 
+void UnityWindow::CleanupCachedTextures()
+{
+  decoration_tex_.clear();
+  decoration_selected_tex_.clear();
+  decoration_title_.clear();
+}
+
 void UnityWindow::scalePaintDecoration(GLWindowPaintAttrib const& attrib,
                                        GLMatrix const& transform,
                                        CompRegion const& region,
@@ -3715,27 +3735,53 @@
     return;
 
   auto const& scaled_geo = GetScaledGeometry();
-  auto const& decoration_extents = window->border();
   auto const& pos = scale_win->getCurrentPosition();
 
   const bool highlighted = (ss->getSelectedWindow() == window->id());
-  int width = scaled_geo.width;
-  int height = decoration_extents.top;
   int x = scaled_geo.x;
   int y = scaled_geo.y;
 
+  mask |= PAINT_WINDOW_BLEND_MASK;
 
-  // If window is not highlighted, we draw the decoration at scaled size
   if (!highlighted)
-    height *= pos.scale;
-
-  DrawWindowDecoration(attrib, transform, mask, highlighted, x, y, width, height);
-
-  if (highlighted)
-  {
-    x += SCALE_ITEMS_PADDING;
-    y += (height - SCALE_CLOSE_ICON_SIZE) / 2.0f;
-    mask |= PAINT_WINDOW_BLEND_MASK;
+  {
+    BuildDecorationTexture();
+    DrawTexture(decoration_tex_, attrib, transform, mask, x, y, pos.scale);
+    close_button_geo_.Set(0, 0, 0, 0);
+  }
+  else
+  {
+    auto const& decoration_extents = window->border();
+    int width = scaled_geo.width;
+    int height = decoration_extents.top;
+    bool redraw_decoration = true;
+
+    if (!decoration_selected_tex_.empty())
+    {
+      GLTexture* texture = decoration_selected_tex_.front();
+
+      if (texture->width() == width && texture->height() == height)
+      {
+        if (decoration_title_ == WindowManager::Default()->GetWindowName(window->id()))
+          redraw_decoration = false;
+      }
+    }
+
+    if (redraw_decoration)
+    {
+      CairoContext context(width, height);
+      RenderDecoration(context, pos.scale);
+
+      // Draw window title
+      int text_x = scale::decoration::ITEMS_PADDING * 2 + scale::decoration::CLOSE_SIZE;
+      RenderText(context, text_x, 0.0, width - scale::decoration::ITEMS_PADDING, height);
+      decoration_selected_tex_ = context.texture_;
+    }
+
+    DrawTexture(decoration_selected_tex_, attrib, transform, mask, x, y);
+
+    x += scale::decoration::ITEMS_PADDING;
+    y += (height - scale::decoration::CLOSE_SIZE) / 2.0f;
 
     switch (close_icon_state_)
     {
@@ -3753,11 +3799,7 @@
         break;
     }
 
-    close_button_geo_.Set(x, y, SCALE_CLOSE_ICON_SIZE, SCALE_CLOSE_ICON_SIZE);
-  }
-  else if (!close_button_geo_.IsNull())
-  {
-    close_button_geo_.Set(0, 0, 0, 0);
+    close_button_geo_.Set(x, y, scale::decoration::CLOSE_SIZE, scale::decoration::CLOSE_SIZE);
   }
 }
 
@@ -3777,7 +3819,7 @@
   return nux::Geometry(x, y, width, height);
 }
 
-void UnityWindow::OnInitiateSpreed()
+void UnityWindow::OnInitiateSpread()
 {
   close_icon_state_ = panel::WindowState::NORMAL;
   middle_clicked_ = false;
@@ -3790,13 +3832,15 @@
     wm->Decorate(xid);
 }
 
-void UnityWindow::OnTerminateSpreed()
+void UnityWindow::OnTerminateSpread()
 {
   WindowManager *wm = WindowManager::Default();
   Window xid = window->id();
 
   if (wm->IsWindowDecorated(xid) && wm->IsWindowMaximized(xid))
     wm->Undecorate(xid);
+
+  CleanupCachedTextures();
 }
 
 UnityWindow::~UnityWindow()

=== modified file 'plugins/unityshell/src/unityshell.h'
--- plugins/unityshell/src/unityshell.h	2012-09-24 15:22:57 +0000
+++ plugins/unityshell/src/unityshell.h	2012-09-24 18:46:21 +0000
@@ -359,34 +359,22 @@
 
   nux::Geometry last_bound;
 
-  void minimize ();
-  void unminimize ();
-  bool minimized ();
-  bool focus ();
-  void activate ();
+  void minimize();
+  void unminimize();
+  bool minimized();
+  bool focus();
+  void activate();
 
-  void updateFrameRegion (CompRegion &region);
+  void updateFrameRegion(CompRegion &region);
 
   /* occlusion detection
    * and window hiding */
-  bool glPaint(const GLWindowPaintAttrib& attrib,
-               const GLMatrix&            matrix,
-               const CompRegion&          region,
-               unsigned int              mask);
+  bool glPaint(GLWindowPaintAttrib const&, GLMatrix const&, CompRegion const&, unsigned mask);
 
   /* basic window draw function */
-  bool glDraw(const GLMatrix& matrix,
-              const GLWindowPaintAttrib& attrib,
-              const CompRegion& region,
-              unsigned intmask);
-
-  void updateIconPos (int   &wx,
-                      int   &wy,
-                      int   x,
-                      int   y,
-                      float width,
-                      float height);
-
+  bool glDraw(GLMatrix const&, GLWindowPaintAttrib const&, CompRegion const&, unsigned mask);
+
+  void updateIconPos (int &wx, int &wy, int x, int y, float width, float height);
   void windowNotify(CompWindowNotify n);
   void moveNotify(int x, int y, bool immediate);
   void resizeNotify(int x, int y, int w, int h);
@@ -396,32 +384,26 @@
   CompPoint tryNotIntersectUI(CompPoint& pos);
   nux::Geometry GetScaledGeometry();
 
-  void paintThumbnail (nux::Geometry const& bounding, float alpha);
+  void paintThumbnail(nux::Geometry const& bounding, float alpha);
 
-  void enterShowDesktop ();
-  void leaveShowDesktop ();
-  bool HandleAnimations (unsigned int ms);
+  void enterShowDesktop();
+  void leaveShowDesktop();
+  bool HandleAnimations(unsigned int ms);
 
   bool handleEvent(XEvent *event);
-
+  void scalePaintDecoration(GLWindowPaintAttrib const&, GLMatrix const&, CompRegion const&, unsigned mask);
+
+  //! Emited when CompWindowNotifyBeforeDestroy is received
+  sigc::signal<void> being_destroyed;
+
+
+protected:
+  std::string GetName() const;
+  void AddProperties(GVariantBuilder* builder);
+
+private:
   typedef compiz::CompizMinimizedWindowHandler<UnityScreen, UnityWindow>
           UnityMinimizedHandler;
-  std::unique_ptr <UnityMinimizedHandler> mMinimizeHandler;
-  std::unique_ptr <ShowdesktopHandler> mShowdesktopHandler;
-
-  //! Emited when CompWindowNotifyBeforeDestroy is received
-  sigc::signal<void> being_destroyed;
-
-  void scalePaintDecoration(const GLWindowPaintAttrib &,
-                            const GLMatrix &,
-                            const CompRegion &,
-                            unsigned int);
-
-protected:
-  std::string GetName() const;
-  void AddProperties(GVariantBuilder* builder);
-
-private:
   struct CairoContext;
 
   void DoEnableFocus ();
@@ -443,8 +425,8 @@
   void DoShow ();
   void DoNotifyShown ();
 
-  void OnInitiateSpreed();
-  void OnTerminateSpreed();
+  void OnInitiateSpread();
+  void OnTerminateSpread();
 
   void DoAddDamage ();
   ShowdesktopHandlerWindowInterface::PostPaintAction DoHandleAnimations (unsigned int ms);
@@ -457,20 +439,28 @@
 
   compiz::WindowInputRemoverLock::Ptr GetInputRemover ();
 
-  void DrawWindowDecoration(GLWindowPaintAttrib const& attrib, GLMatrix const& transform,
-                            unsigned int mask, bool highlighted,
-                            int x, int y, unsigned width, unsigned height);
-  void DrawTexture(GLTexture::List const& textures, GLWindowPaintAttrib const& attrib,
-                   GLMatrix const& transform, unsigned int mask, int x, int y);
-  void RenderText(CairoContext const& context, int x, int y, int width, int height);
+  void RenderDecoration(CairoContext const&, double aspect = 1.0f);
+  void RenderText(CairoContext const&, int x, int y, int width, int height);
+  void DrawTexture(GLTexture::List const& textures, GLWindowPaintAttrib const&,
+                   GLMatrix const&, unsigned mask, int x, int y, double scale = 1.0f);
 
+  void BuildDecorationTexture();
+  void CleanupCachedTextures();
   static void SetupSharedTextures();
   static void CleanupSharedTextures();
   static void LoadCloseIcon(panel::WindowState state, GLTexture::List& texture);
 
+public:
+  std::unique_ptr <UnityMinimizedHandler> mMinimizeHandler;
+
+private:
+  std::unique_ptr <ShowdesktopHandler> mShowdesktopHandler;
   static GLTexture::List close_normal_tex_;
   static GLTexture::List close_prelight_tex_;
   static GLTexture::List close_pressed_tex_;
+  GLTexture::List decoration_tex_;
+  GLTexture::List decoration_selected_tex_;
+  std::string decoration_title_;
   compiz::WindowInputRemoverLock::Weak input_remover_;
   panel::WindowState close_icon_state_;
   nux::Geometry close_button_geo_;