Tab audio mute control (views UI), behind a switch (off by default).

chrome/browser/ui/tabs/tab_strip_model.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/tabs/tab_strip_model.h"
 
 #include <algorithm>
 #include <map>
 #include <string>
 
 #include "base/metrics/histogram.h"
 #include "base/stl_util.h"
 #include "chrome/app/chrome_command_ids.h"
 #include "chrome/browser/browser_shutdown.h"
 #include "chrome/browser/defaults.h"
 #include "chrome/browser/extensions/tab_helper.h"
 #include "chrome/browser/profiles/profile.h"
 #include "chrome/browser/ui/tab_contents/core_tab_helper.h"
 #include "chrome/browser/ui/tab_contents/core_tab_helper_delegate.h"
 #include "chrome/browser/ui/tabs/tab_strip_model_delegate.h"
 #include "chrome/browser/ui/tabs/tab_strip_model_order_controller.h"
+#include "chrome/browser/ui/tabs/tab_utils.h"
 #include "chrome/browser/ui/web_contents_sizer.h"
 #include "chrome/common/url_constants.h"
 #include "components/web_modal/popup_manager.h"
 #include "content/public/browser/render_process_host.h"
 #include "content/public/browser/user_metrics.h"
 #include "content/public/browser/web_contents.h"
 #include "content/public/browser/web_contents_observer.h"
 using base::UserMetricsAction;
 using content::WebContents;
 
@@ skipping 662 matching lines @@
   FOR_EACH_OBSERVER(TabStripModelObserver, observers_,
                     TabPinnedStateChanged(contents_data_[index]->web_contents(),
                                           index));
 }
 
 bool TabStripModel::IsTabPinned(int index) const {
   DCHECK(ContainsIndex(index));
   return contents_data_[index]->pinned();
 }
 
+void TabStripModel::SetTabAudioMuted(int index, bool mute) {

[sky, 2014/09/23 22:58:17]

Move this and IsTabAudioMuted into tab_util. My rationale here is that
TabStripModel shouldn't contain any of the command execution. That should all be
moved to a separate object and TabStripModel slimmed down.
Also, you should DCHECK the index if valid and not null check GetWebContentsAt.

[miu, 2014/09/24 22:34:15]

Done.  Agreed; I wasn't encapsulating this functionality in the right place.

[sky, 2014/09/25 19:25:04]

Can you also move the setters? Long term TabStripModel shouldn't have any of the
command stuff, it should be a separate object (or just a bunch of functions like
you have in tab_util).

[miu, 2014/09/25 22:49:36]

Done.

+  content::WebContents* const contents = GetWebContentsAt(index);
+  if (!contents || !chrome::CanToggleAudioMute(contents))
+    return;
+  contents->SetAudioMuted(mute);
+}
+
+bool TabStripModel::IsTabAudioMuted(int index) const {
+  content::WebContents* const contents = GetWebContentsAt(index);
+  return contents && contents->IsAudioMuted();
+}
+
 bool TabStripModel::IsMiniTab(int index) const {
   return IsTabPinned(index) || IsAppTab(index);
 }
 
 bool TabStripModel::IsAppTab(int index) const {
   WebContents* contents = GetWebContentsAt(index);
   return contents && extensions::TabHelper::FromWebContents(contents)->is_app();
 }
 
 bool TabStripModel::IsTabBlocked(int index) const {
@@ skipping 198 matching lines @@
 
     case CommandTogglePinned: {
       std::vector<int> indices = GetIndicesForCommand(context_index);
       for (size_t i = 0; i < indices.size(); ++i) {
         if (!IsAppTab(indices[i]))
           return true;
       }
       return false;
     }
 
+    case CommandToggleTabAudioMuted: {
+      if (!chrome::IsTabAudioMutingFeatureEnabled())

[sky, 2014/09/23 22:58:17]

Does this check matter here?

[miu, 2014/09/24 22:34:15]

Done since the CanToggleAudioMute() should return false if the feature is not
enabled.

+        return false;
+      std::vector<int> indices = GetIndicesForCommand(context_index);
+      for (size_t i = 0; i < indices.size(); ++i) {
+        WebContents* const tab = GetWebContentsAt(indices[i]);
+        if (!tab || !chrome::CanToggleAudioMute(tab))

[sky, 2014/09/23 22:58:17]

You shouldn't need the !tab here, at which point you can nuke the temporary.

[miu, 2014/09/24 22:34:15]

Done.

+          return false;
+      }
+      return true;
+    }
+
     case CommandBookmarkAllTabs:
       return browser_defaults::bookmarks_enabled &&
           delegate_->CanBookmarkAllTabs();
 
     case CommandSelectByDomain:
     case CommandSelectByOpener:
       return true;
 
     default:
       NOTREACHED();
@@ skipping 87 matching lines @@
         // Unpin from the back so that the order is maintained (unpinning can
         // trigger moving a tab).
         for (size_t i = indices.size(); i > 0; --i) {
           if (!IsAppTab(indices[i - 1]))
             SetTabPinned(indices[i - 1], false);
         }
       }
       break;
     }
 
+    case CommandToggleTabAudioMuted: {
+      const bool mute = WillContextMenuMute(context_index);
+      if (mute)
+        content::RecordAction(UserMetricsAction("TabContextMenu_MuteTabs"));
+      else
+        content::RecordAction(UserMetricsAction("TabContextMenu_UnmuteTabs"));
+      std::vector<int> indices = GetIndicesForCommand(context_index);
+      for (size_t i = 0; i < indices.size(); ++i)
+        SetTabAudioMuted(indices[i], mute);
+      break;
+    }
+
     case CommandBookmarkAllTabs: {
       content::RecordAction(
           UserMetricsAction("TabContextMenu_BookmarkAllTabs"));
 
       delegate_->BookmarkAllTabs();
       break;
     }
 
     case CommandSelectByDomain:
     case CommandSelectByOpener: {
@@ skipping 45 matching lines @@
   std::vector<int> indices = GetIndicesForCommand(index);
   // If all tabs are pinned, then we unpin, otherwise we pin.
   bool all_pinned = true;
   for (size_t i = 0; i < indices.size() && all_pinned; ++i) {
     if (!IsAppTab(index))  // We never change app tabs.
       all_pinned = IsTabPinned(indices[i]);
   }
   return !all_pinned;
 }
 
+bool TabStripModel::WillContextMenuMute(int index) {

[sky, 2014/09/23 22:58:17]

Move this to tab_util and make it take a const std::vector<int>& indices. At
which point a better name is AreAllTabsMuted.

[miu, 2014/09/24 22:34:15]

Done.

+  std::vector<int> indices = GetIndicesForCommand(index);
+  // If all tabs are muted, then we unmute, otherwise we mute.
+  for (size_t i = 0; i < indices.size(); ++i) {
+    if (!IsTabAudioMuted(indices[i]))
+      return true;
+  }
+  return false;
+}
+
 // static
 bool TabStripModel::ContextMenuCommandToBrowserCommand(int cmd_id,
                                                        int* browser_cmd) {
   switch (cmd_id) {
     case CommandNewTab:
       *browser_cmd = IDC_NEW_TAB;
       break;
     case CommandReload:
       *browser_cmd = IDC_RELOAD;
       break;
@@ skipping 301 matching lines @@
 void TabStripModel::ForgetOpenersAndGroupsReferencing(
     const WebContents* tab) {
   for (WebContentsDataVector::const_iterator i = contents_data_.begin();
        i != contents_data_.end(); ++i) {
     if ((*i)->group() == tab)
       (*i)->set_group(NULL);
     if ((*i)->opener() == tab)
       (*i)->set_opener(NULL);
   }
 }