Desaturate the favicon shown in the tab when a network error is encountered

chrome/browser/ui/views/tabs/tab.cc

 // Copyright (c) 2012 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 #include "chrome/browser/ui/views/tabs/tab.h"
 
 #include <stddef.h>
 #include <limits>
 #include <utility>
 
@@ skipping 13 matching lines @@
 #include "chrome/browser/ui/views/touch_uma/touch_uma.h"
 #include "chrome/common/chrome_switches.h"
 #include "chrome/common/url_constants.h"
 #include "chrome/grit/generated_resources.h"
 #include "content/public/browser/user_metrics.h"
 #include "content/public/common/url_constants.h"
 #include "grit/components_scaled_resources.h"
 #include "grit/components_strings.h"
 #include "grit/theme_resources.h"
 #include "third_party/skia/include/effects/SkGradientShader.h"
+#include "third_party/skia/include/effects/SkLumaColorFilter.h"
 #include "third_party/skia/include/pathops/SkPathOps.h"
 #include "ui/accessibility/ax_view_state.h"
 #include "ui/base/l10n/l10n_util.h"
 #include "ui/base/material_design/material_design_controller.h"
 #include "ui/base/models/list_selection_model.h"
 #include "ui/base/resource/resource_bundle.h"
 #include "ui/base/theme_provider.h"
 #include "ui/gfx/animation/animation_container.h"
 #include "ui/gfx/animation/throb_animation.h"
 #include "ui/gfx/canvas.h"
@@ skipping 527 matching lines @@
     canvas->DrawImageInt(*stroke_images->image_l, 0, 0);
     canvas->TileImageInt(
         *stroke_images->image_c, stroke_images->l_width, 0,
         rect.width() - stroke_images->l_width - stroke_images->r_width,
         rect.height());
     canvas->DrawImageInt(*stroke_images->image_r,
                          rect.width() - stroke_images->r_width, 0);
   }
 }
 
+// Destaurates the favicon. Should only be used for when a tab encounters a
+// network error state.
+void PaintDesaturatedFavIcon(gfx::Canvas* canvas,
+                             gfx::ImageSkia& favicon,
+                             gfx::Rect bounds) {

[sky, 2016/08/12 15:29:25]

const gfx::Rect&

[edwardjung, 2016/08/12 19:29:25]

Done.

+  SkPaint paint;
+  paint.setStyle(SkPaint::kFill_Style);
+  paint.setAntiAlias(true);
+  SkScalar desaturate[20] = {0.3086f, 0.6094f, 0.0820f, 0.0f, 0.0f,

[sky, 2016/08/12 15:29:25]

These constants look rather magical. Are they defined as a constants some where?

[edwardjung, 2016/08/12 19:29:25]

I've switched to use CreateHSLShiftedImage which has easier to understand
parameters using a HSL shift.

+                             0.3086f, 0.6094f, 0.0820f, 0.0f, 0.0f,
+                             0.3086f, 0.6094f, 0.0820f, 0.0f, 0.0f,
+                             0.0f,    0.0f,    0.0f,    0.8f, 0.0f};
+  paint.setColorFilter(SkColorFilter::MakeMatrixFilterRowMajor255(desaturate));
+  if (!bounds.IsEmpty()) {
+    canvas->DrawImageInt(favicon, 0, 0, bounds.width(), bounds.height(),
+                         bounds.x(), bounds.y(), bounds.width(),
+                         bounds.height(), false, paint);
+  } else {
+    canvas->DrawImageInt(favicon, 0, 0, paint);
+  }
+}
+
 }  // namespace
 
 ////////////////////////////////////////////////////////////////////////////////
 // FaviconCrashAnimation
 //
 //  A custom animation subclass to manage the favicon crash animation.
 class Tab::FaviconCrashAnimation : public gfx::LinearAnimation,
                                    public gfx::AnimationDelegate {
  public:
   explicit FaviconCrashAnimation(Tab* target)
@@ skipping 161 matching lines @@
   loading_start_time_ = base::TimeTicks();
   waiting_state_ = gfx::ThrobberWaitingState();
 }
 
 bool Tab::ThrobberView::CanProcessEventsWithinSubtree() const {
   return false;
 }
 
 void Tab::ThrobberView::OnPaint(gfx::Canvas* canvas) {
   const TabRendererData::NetworkState state = owner_->data().network_state;
-  if (state == TabRendererData::NETWORK_STATE_NONE)
+  if (state == TabRendererData::NETWORK_STATE_NONE ||
+      state == TabRendererData::NETWORK_STATE_ERROR)
     return;
 
   const ui::ThemeProvider* tp = GetThemeProvider();
   const gfx::Rect bounds = GetLocalBounds();
   if (state == TabRendererData::NETWORK_STATE_WAITING) {
     if (waiting_start_time_ == base::TimeTicks())
       waiting_start_time_ = base::TimeTicks::Now();
 
     waiting_state_.elapsed_time = base::TimeTicks::Now() - waiting_start_time_;
     gfx::PaintThrobberWaiting(
@@ skipping 117 matching lines @@
 void Tab::AlertStateChanged() {
   Layout();
 }
 
 bool Tab::IsSelected() const {
   return controller_->IsTabSelected(this);
 }
 
 void Tab::SetData(const TabRendererData& data) {
   DCHECK(GetWidget());
-
   if (data_.Equals(data))
     return;
 
   TabRendererData old(data_);
   UpdateLoadingAnimation(data.network_state);
   data_ = data;
 
   base::string16 title = data_.title;
   if (title.empty()) {
     title = data_.loading ?
@@ skipping 21 matching lines @@
     showing_pinned_tab_title_changed_indicator_ = false;
 
   DataChanged(old);
 
   Layout();
   SchedulePaint();
 }
 
 void Tab::UpdateLoadingAnimation(TabRendererData::NetworkState state) {
   if (state == data_.network_state &&
-      state == TabRendererData::NETWORK_STATE_NONE) {
+      (state == TabRendererData::NETWORK_STATE_NONE ||
+       state == TabRendererData::NETWORK_STATE_ERROR)) {
     // If the network state is none and hasn't changed, do nothing. Otherwise we

[sky, 2016/08/12 15:29:25]

update comment

[edwardjung, 2016/08/12 19:29:25]

Done.

     // need to advance the animation frame.
     return;
   }
 
   data_.network_state = state;
   AdvanceLoadingAnimation();
 }
 
 void Tab::StartPulse() {
   pulse_animation_->StartThrobbing(std::numeric_limits<int>::max());
@@ skipping 633 matching lines @@
     const gfx::Rect& favicon_draw_bounds) {
   // The pinned tab title changed indicator consists of two parts:
   // . a clear (totally transparent) part over the bottom right (or left in rtl)
   //   of the favicon. This is done by drawing the favicon to a canvas, then
   //   drawing the clear part on top of the favicon.
   // . a circle in the bottom right (or left in rtl) of the favicon.
   if (!favicon_.isNull()) {
     const float kIndicatorCropRadius = 4.5;
     gfx::Canvas icon_canvas(gfx::Size(gfx::kFaviconSize, gfx::kFaviconSize),
                             canvas->image_scale(), false);
-    icon_canvas.DrawImageInt(favicon_, 0, 0);
+
+    if (data().network_state == TabRendererData::NETWORK_STATE_ERROR)
+      PaintDesaturatedFavIcon(&icon_canvas, favicon_, gfx::Rect());
+    else
+      icon_canvas.DrawImageInt(favicon_, 0, 0);
+
     SkPaint clear_paint;
     clear_paint.setAntiAlias(true);
     clear_paint.setXfermodeMode(SkXfermode::kClear_Mode);
     const int circle_x = base::i18n::IsRTL() ? 0 : gfx::kFaviconSize;
     icon_canvas.DrawCircle(gfx::PointF(circle_x, gfx::kFaviconSize),
                            kIndicatorCropRadius, clear_paint);
     canvas->DrawImageInt(gfx::ImageSkia(icon_canvas.ExtractImageRep()), 0, 0,
                          favicon_draw_bounds.width(),
                          favicon_draw_bounds.height(), favicon_draw_bounds.x(),
                          favicon_draw_bounds.y(), favicon_draw_bounds.width(),
@@ skipping 16 matching lines @@
 
 void Tab::PaintIcon(gfx::Canvas* canvas) {
   gfx::Rect bounds = favicon_bounds_;
   bounds.set_x(GetMirroredXForRect(bounds));
   bounds.Offset(0, favicon_hiding_offset_);
   bounds.Intersect(GetContentsBounds());
   if (bounds.IsEmpty())
     return;
 
   // Throbber will do its own painting.
-  if (data().network_state != TabRendererData::NETWORK_STATE_NONE)
+  if (data().network_state != TabRendererData::NETWORK_STATE_NONE &&
+      data().network_state != TabRendererData::NETWORK_STATE_ERROR)
     return;
 
   // Ensure that |favicon_| is created.
   if (favicon_.isNull()) {
     ui::ResourceBundle* rb = &ui::ResourceBundle::GetSharedInstance();
     favicon_ = should_display_crashed_favicon_
                    ? *rb->GetImageSkiaNamed(IDR_CRASH_SAD_FAVICON)
                    : data().favicon;
     // Themify the icon if it's a chrome:// page or if it's the sadtab favicon.
     // This ensures chrome:// pages are visible over the tab background. This is
     // similar to code in the bookmarks bar.
     if (!favicon_.isNull() &&
         (should_display_crashed_favicon_ ||
          favicon_.BackedBySameObjectAs(
              *rb->GetImageSkiaNamed(IDR_DEFAULT_FAVICON)) ||
          ShouldThemifyFaviconForUrl(data().url))) {
       favicon_ = gfx::ImageSkiaOperations::CreateHSLShiftedImage(
           favicon_, GetThemeProvider()->GetTint(ThemeProperties::TINT_BUTTONS));
     }
   }
 
   if (showing_pinned_tab_title_changed_indicator_ &&
       !should_display_crashed_favicon_) {
     PaintPinnedTabTitleChangedIndicatorAndIcon(canvas, bounds);
   } else if (!favicon_.isNull()) {
-    canvas->DrawImageInt(favicon_, 0, 0, bounds.width(), bounds.height(),
-                         bounds.x(), bounds.y(), bounds.width(),
-                         bounds.height(), false);
+    // Desaturate favicons of tabs with network errors.
+    if (data().network_state == TabRendererData::NETWORK_STATE_ERROR) {
+      PaintDesaturatedFavIcon(canvas, favicon_, bounds);
+    } else {
+      canvas->DrawImageInt(favicon_, 0, 0, bounds.width(), bounds.height(),
+                           bounds.x(), bounds.y(), bounds.width(),
+                           bounds.height(), false);
+    }
   }
 }
 
 void Tab::AdvanceLoadingAnimation() {
   const TabRendererData::NetworkState state = data().network_state;
   if (controller_->IsImmersiveStyle()) {
     throbber_->SetVisible(false);
     if (state == TabRendererData::NETWORK_STATE_WAITING) {
       // Waiting steps backwards.
       immersive_loading_step_ =
           (immersive_loading_step_ - 1 + kImmersiveLoadingStepCount) %
           kImmersiveLoadingStepCount;
     } else if (state == TabRendererData::NETWORK_STATE_LOADING) {
       immersive_loading_step_ =
           (immersive_loading_step_ + 1) % kImmersiveLoadingStepCount;
     } else {
       immersive_loading_step_ = 0;
     }
 
     SchedulePaintInRect(GetImmersiveBarRect());
     return;
   }
 
-  if (state == TabRendererData::NETWORK_STATE_NONE) {
+  if (state == TabRendererData::NETWORK_STATE_NONE ||
+      state == TabRendererData::NETWORK_STATE_ERROR) {
     throbber_->ResetStartTimes();
     throbber_->SetVisible(false);
     ScheduleIconPaint();
     return;
   }
 
   // Since the throbber can animate for a long time, paint to a separate layer
   // when possible to reduce repaint overhead.
   const bool paint_to_layer = controller_->CanPaintThrobberToLayer();
   if (paint_to_layer != !!throbber_->layer()) {
@@ skipping 124 matching lines @@
 gfx::Rect Tab::GetImmersiveBarRect() const {
   // The main bar is as wide as the normal tab's horizontal top line.
   // This top line of the tab extends a few pixels left and right of the
   // center image due to pixels in the rounded corner images.
   const int kBarPadding = 1;
   int main_bar_left = g_active_images.l_width - kBarPadding;
   int main_bar_right = width() - g_active_images.r_width + kBarPadding;
   return gfx::Rect(
       main_bar_left, 0, main_bar_right - main_bar_left, kImmersiveBarHeight);
 }