1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157
|
// Copyright 2020 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#include "components/live_caption/caption_util.h"
#include <stddef.h>
#include "base/command_line.h"
#include "base/feature_list.h"
#include "base/metrics/histogram_functions.h"
#include "base/notreached.h"
#include "base/strings/string_number_conversions.h"
#include "base/strings/stringprintf.h"
#include "build/build_config.h"
#include "components/live_caption/pref_names.h"
#include "components/prefs/pref_service.h"
#include "media/base/media_switches.h"
#include "ui/base/ui_base_switches.h"
#include "ui/native_theme/native_theme.h"
#if BUILDFLAG(IS_WIN)
#include "base/win/windows_version.h"
#endif
#if !BUILDFLAG(IS_FUCHSIA) && !BUILDFLAG(IS_ANDROID)
#include "components/soda/soda_util.h"
#endif
namespace {
// Returns whether the style is default or not. If the user has changed any of
// the captions settings from the default value, that is an interesting metric
// to observe.
bool IsDefaultStyle(std::optional<ui::CaptionStyle> style) {
return (style.has_value() && style->text_size.empty() &&
style->font_family.empty() && style->text_color.empty() &&
style->background_color.empty() && style->text_shadow.empty());
}
// Adds !important to all captions styles. They should always override any
// styles added by the video author or by a user stylesheet. This is because in
// Chrome, there is an option to turn off captions styles, so any time the
// captions are on, the styles should take priority.
std::string AddCSSImportant(std::string css_string) {
return css_string.empty() ? "" : css_string + " !important";
}
// Constructs the CaptionStyle struct from the caption-related preferences.
std::optional<ui::CaptionStyle> GetCaptionStyleFromPrefs(PrefService* prefs) {
if (!prefs) {
return std::nullopt;
}
ui::CaptionStyle style;
style.text_size =
AddCSSImportant(prefs->GetString(prefs::kAccessibilityCaptionsTextSize));
style.font_family =
AddCSSImportant(prefs->GetString(prefs::kAccessibilityCaptionsTextFont));
if (!prefs->GetString(prefs::kAccessibilityCaptionsTextColor).empty()) {
std::string text_color = base::StringPrintf(
"rgba(%s,%s)",
prefs->GetString(prefs::kAccessibilityCaptionsTextColor).c_str(),
base::NumberToString(
prefs->GetInteger(prefs::kAccessibilityCaptionsTextOpacity) / 100.0)
.c_str());
style.text_color = AddCSSImportant(text_color);
}
if (!prefs->GetString(prefs::kAccessibilityCaptionsBackgroundColor).empty()) {
std::string background_color = base::StringPrintf(
"rgba(%s,%s)",
prefs->GetString(prefs::kAccessibilityCaptionsBackgroundColor).c_str(),
base::NumberToString(
prefs->GetInteger(prefs::kAccessibilityCaptionsBackgroundOpacity) /
100.0)
.c_str());
style.background_color = AddCSSImportant(background_color);
}
style.text_shadow = AddCSSImportant(
prefs->GetString(prefs::kAccessibilityCaptionsTextShadow));
return style;
}
} // namespace
namespace captions {
std::optional<ui::CaptionStyle> GetCaptionStyleFromUserSettings(
PrefService* prefs,
bool record_metrics) {
// Apply native CaptionStyle parameters.
std::optional<ui::CaptionStyle> style;
// Apply native CaptionStyle parameters.
if (base::CommandLine::ForCurrentProcess()->HasSwitch(
::switches::kForceCaptionStyle)) {
style = ui::CaptionStyle::FromSpec(
base::CommandLine::ForCurrentProcess()->GetSwitchValueASCII(
switches::kForceCaptionStyle));
}
// Apply system caption style.
if (!style) {
ui::NativeTheme* native_theme = ui::NativeTheme::GetInstanceForWeb();
style = native_theme->GetSystemCaptionStyle();
if (record_metrics && style.has_value()) {
base::UmaHistogramBoolean(
"Accessibility.CaptionSettingsLoadedFromSystemSettings",
!IsDefaultStyle(style));
}
}
// Apply caption style from preferences if system caption style is undefined.
if (!style) {
style = GetCaptionStyleFromPrefs(prefs);
if (record_metrics && style.has_value()) {
base::UmaHistogramBoolean("Accessibility.CaptionSettingsLoadedFromPrefs",
!IsDefaultStyle(style));
}
}
return style;
}
bool IsLiveCaptionFeatureSupported() {
#if !BUILDFLAG(IS_FUCHSIA) && !BUILDFLAG(IS_ANDROID)
return speech::IsOnDeviceSpeechRecognitionSupported();
#else
return false;
#endif // !BUILDFLAG(IS_FUCHSIA) && !BUILDFLAG(IS_ANDROID)
}
bool IsHeadlessCaptionFeatureSupported() {
return base::FeatureList::IsEnabled(media::kHeadlessLiveCaption);
}
std::string GetCaptionSettingsUrl() {
#if BUILDFLAG(IS_CHROMEOS)
return "chrome://os-settings/audioAndCaptions";
#elif BUILDFLAG(IS_LINUX)
return "chrome://settings/captions";
#elif BUILDFLAG(IS_WIN)
return base::win::GetVersion() >= base::win::Version::WIN10
? "chrome://settings/accessibility"
: "chrome://settings/captions";
#elif BUILDFLAG(IS_MAC)
return "chrome://settings/accessibility";
#else
NOTREACHED();
#endif
}
} // namespace captions
|