chrome/browser/ui/tabs/tab_utils.cc

   1 // Copyright (c) 2012 The Chromium Authors. All rights reserved.
   2 // Use of this source code is governed by a BSD-style license that can be
   3 // found in the LICENSE file.
   4
   5 #include "chrome/browser/ui/tabs/tab_utils.h"
   6
   7 #include "base/strings/string16.h"
   8 #include "chrome/browser/media/media_capture_devices_dispatcher.h"
   9 #include "chrome/browser/media/media_stream_capture_indicator.h"
  10 #include "chrome/grit/generated_resources.h"
  11 #include "content/public/browser/web_contents.h"
  12 #include "grit/theme_resources.h"
  13 #include "ui/base/l10n/l10n_util.h"
  14 #include "ui/base/resource/resource_bundle.h"
  15 #include "ui/gfx/animation/multi_animation.h"
  16
  17 namespace chrome {
  18
  19 namespace {
  20
  21 // Interval between frame updates of the tab indicator animations.  This is not
  22 // the usual 60 FPS because a trade-off must be made between tab UI animation
  23 // smoothness and media recording/playback performance on low-end hardware.
  24 const int kIndicatorFrameIntervalMs = 50;  // 20 FPS
  25
  26 // Fade-in/out duration for the tab indicator animations.  Fade-in is quick to
  27 // immediately notify the user.  Fade-out is more gradual, so that the user has
  28 // a chance of finding a tab that has quickly "blipped" on and off.
  29 const int kIndicatorFadeInDurationMs = 200;
  30 const int kIndicatorFadeOutDurationMs = 1000;
  31
  32 // Animation that throbs in (towards 1.0) and out (towards 0.0), and ends in the
  33 // "in" state.
  34 class TabRecordingIndicatorAnimation : public gfx::MultiAnimation {
  35  public:
  36   virtual ~TabRecordingIndicatorAnimation() {}
  37
  38   // Overridden to provide alternating "towards in" and "towards out" behavior.
  39   virtual double GetCurrentValue() const OVERRIDE;
  40
  41   static scoped_ptr<TabRecordingIndicatorAnimation> Create();
  42
  43  private:
  44   TabRecordingIndicatorAnimation(const gfx::MultiAnimation::Parts& parts,
  45                                  const base::TimeDelta interval)
  46       : MultiAnimation(parts, interval) {}
  47
  48   // Number of times to "toggle throb" the recording and tab capture indicators
  49   // when they first appear.
  50   static const int kCaptureIndicatorThrobCycles = 5;
  51 };
  52
  53 double TabRecordingIndicatorAnimation::GetCurrentValue() const {
  54   return current_part_index() % 2 ?
  55       1.0 - MultiAnimation::GetCurrentValue() :
  56       MultiAnimation::GetCurrentValue();
  57 }
  58
  59 scoped_ptr<TabRecordingIndicatorAnimation>
  60 TabRecordingIndicatorAnimation::Create() {
  61   MultiAnimation::Parts parts;
  62   COMPILE_ASSERT(kCaptureIndicatorThrobCycles % 2 != 0,
  63                  must_be_odd_so_animation_finishes_in_showing_state);
  64   for (int i = 0; i < kCaptureIndicatorThrobCycles; ++i) {
  65     parts.push_back(MultiAnimation::Part(
  66         i % 2 ? kIndicatorFadeOutDurationMs : kIndicatorFadeInDurationMs,
  67         gfx::Tween::EASE_IN));
  68   }
  69   const base::TimeDelta interval =
  70       base::TimeDelta::FromMilliseconds(kIndicatorFrameIntervalMs);
  71   scoped_ptr<TabRecordingIndicatorAnimation> animation(
  72       new TabRecordingIndicatorAnimation(parts, interval));
  73   animation->set_continuous(false);
  74   return animation.Pass();
  75 }
  76
  77 }  // namespace
  78
  79 bool ShouldTabShowFavicon(int capacity,
  80                           bool is_pinned_tab,
  81                           bool is_active_tab,
  82                           bool has_favicon,
  83                           TabMediaState media_state) {
  84   if (!has_favicon)
  85     return false;
  86   int required_capacity = 1;
  87   if (ShouldTabShowCloseButton(capacity, is_pinned_tab, is_active_tab))
  88     ++required_capacity;
  89   if (ShouldTabShowMediaIndicator(
  90           capacity, is_pinned_tab, is_active_tab, has_favicon, media_state)) {
  91     ++required_capacity;
  92   }
  93   return capacity >= required_capacity;
  94 }
  95
  96 bool ShouldTabShowMediaIndicator(int capacity,
  97                                  bool is_pinned_tab,
  98                                  bool is_active_tab,
  99                                  bool has_favicon,
 100                                  TabMediaState media_state) {
 101   if (media_state == TAB_MEDIA_STATE_NONE)
 102     return false;
 103   if (ShouldTabShowCloseButton(capacity, is_pinned_tab, is_active_tab))
 104     return capacity >= 2;
 105   return capacity >= 1;
 106 }
 107
 108 bool ShouldTabShowCloseButton(int capacity,
 109                               bool is_pinned_tab,
 110                               bool is_active_tab) {
 111   if (is_pinned_tab)
 112     return false;
 113   else if (is_active_tab)
 114     return true;
 115   else
 116     return capacity >= 3;
 117 }
 118
 119 bool IsPlayingAudio(content::WebContents* contents) {
 120   return contents->WasRecentlyAudible();
 121 }
 122
 123 TabMediaState GetTabMediaStateForContents(content::WebContents* contents) {
 124   if (!contents)
 125     return TAB_MEDIA_STATE_NONE;
 126
 127   scoped_refptr<MediaStreamCaptureIndicator> indicator =
 128       MediaCaptureDevicesDispatcher::GetInstance()->
 129           GetMediaStreamCaptureIndicator();
 130   if (indicator.get()) {
 131     if (indicator->IsBeingMirrored(contents))
 132       return TAB_MEDIA_STATE_CAPTURING;
 133     if (indicator->IsCapturingUserMedia(contents))
 134       return TAB_MEDIA_STATE_RECORDING;
 135   }
 136
 137   if (IsPlayingAudio(contents))
 138     return TAB_MEDIA_STATE_AUDIO_PLAYING;
 139
 140   return TAB_MEDIA_STATE_NONE;
 141 }
 142
 143 const gfx::Image& GetTabMediaIndicatorImage(TabMediaState media_state) {
 144   ui::ResourceBundle& rb = ui::ResourceBundle::GetSharedInstance();
 145   switch (media_state) {
 146     case TAB_MEDIA_STATE_AUDIO_PLAYING:
 147       return rb.GetNativeImageNamed(IDR_TAB_AUDIO_INDICATOR);
 148     case TAB_MEDIA_STATE_RECORDING:
 149       return rb.GetNativeImageNamed(IDR_TAB_RECORDING_INDICATOR);
 150     case TAB_MEDIA_STATE_CAPTURING:
 151       return rb.GetNativeImageNamed(IDR_TAB_CAPTURE_INDICATOR);
 152     case TAB_MEDIA_STATE_NONE:
 153       break;
 154   }
 155   NOTREACHED();
 156   return rb.GetNativeImageNamed(IDR_SAD_FAVICON);
 157 }
 158
 159 scoped_ptr<gfx::Animation> CreateTabMediaIndicatorFadeAnimation(
 160     TabMediaState media_state) {
 161   if (media_state == TAB_MEDIA_STATE_RECORDING ||
 162       media_state == TAB_MEDIA_STATE_CAPTURING) {
 163     return TabRecordingIndicatorAnimation::Create().PassAs<gfx::Animation>();
 164   }
 165
 166   // Note: While it seems silly to use a one-part MultiAnimation, it's the only
 167   // gfx::Animation implementation that lets us control the frame interval.
 168   gfx::MultiAnimation::Parts parts;
 169   const bool is_for_fade_in = (media_state != TAB_MEDIA_STATE_NONE);
 170   parts.push_back(gfx::MultiAnimation::Part(
 171       is_for_fade_in ? kIndicatorFadeInDurationMs : kIndicatorFadeOutDurationMs,
 172       gfx::Tween::EASE_IN));
 173   const base::TimeDelta interval =
 174       base::TimeDelta::FromMilliseconds(kIndicatorFrameIntervalMs);
 175   scoped_ptr<gfx::MultiAnimation> animation(
 176       new gfx::MultiAnimation(parts, interval));
 177   animation->set_continuous(false);
 178   return animation.PassAs<gfx::Animation>();
 179 }
 180
 181 base::string16 AssembleTabTooltipText(const base::string16& title,
 182                                       TabMediaState media_state) {
 183   if (media_state == TAB_MEDIA_STATE_NONE)
 184     return title;
 185
 186   base::string16 result = title;
 187   if (!result.empty())
 188     result.append(1, '\n');
 189   switch (media_state) {
 190     case TAB_MEDIA_STATE_AUDIO_PLAYING:
 191       result.append(
 192           l10n_util::GetStringUTF16(IDS_TOOLTIP_TAB_MEDIA_STATE_AUDIO_PLAYING));
 193       break;
 194     case TAB_MEDIA_STATE_RECORDING:
 195       result.append(
 196           l10n_util::GetStringUTF16(IDS_TOOLTIP_TAB_MEDIA_STATE_RECORDING));
 197       break;
 198     case TAB_MEDIA_STATE_CAPTURING:
 199       result.append(
 200           l10n_util::GetStringUTF16(IDS_TOOLTIP_TAB_MEDIA_STATE_CAPTURING));
 201       break;
 202     case TAB_MEDIA_STATE_NONE:
 203       NOTREACHED();
 204       break;
 205   }
 206   return result;
 207 }
 208
 209 }  // namespace chrome