File: media_item_ui_helper.cc

package info (click to toggle)
chromium 138.0.7204.183-1~deb12u1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm-proposed-updates
  • size: 6,080,960 kB
  • sloc: cpp: 34,937,079; ansic: 7,176,967; javascript: 4,110,704; python: 1,419,954; asm: 946,768; xml: 739,971; pascal: 187,324; sh: 89,623; perl: 88,663; objc: 79,944; sql: 50,304; cs: 41,786; fortran: 24,137; makefile: 21,811; php: 13,980; tcl: 13,166; yacc: 8,925; ruby: 7,485; awk: 3,720; lisp: 3,096; lex: 1,327; ada: 727; jsp: 228; sed: 36
file content (339 lines) | stat: -rw-r--r-- 13,337 bytes parent folder | download | duplicates (5)
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
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
// Copyright 2023 The Chromium Authors
// 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/global_media_controls/media_item_ui_helper.h"

#include "chrome/app/vector_icons/vector_icons.h"
#include "chrome/browser/media/router/media_router_feature.h"
#include "chrome/browser/profiles/profile.h"
#include "chrome/browser/ui/global_media_controls/cast_media_notification_item.h"
#include "chrome/browser/ui/global_media_controls/media_item_ui_metrics.h"
#include "chrome/browser/ui/views/global_media_controls/cast_device_footer_view.h"
#include "chrome/browser/ui/views/global_media_controls/cast_device_selector_view.h"
#include "chrome/browser/ui/views/global_media_controls/media_dialog_view.h"
#include "chrome/browser/ui/views/global_media_controls/media_item_ui_cast_footer_view.h"
#include "chrome/browser/ui/views/global_media_controls/media_item_ui_device_selector_view.h"
#include "chrome/browser/ui/views/global_media_controls/media_item_ui_legacy_cast_footer_view.h"
#include "components/global_media_controls/public/constants.h"
#include "components/global_media_controls/public/media_session_notification_item.h"
#include "components/global_media_controls/public/mojom/device_service.mojom.h"
#include "components/media_message_center/media_notification_item.h"
#include "components/media_router/browser/media_router.h"
#include "components/media_router/browser/media_router_factory.h"
#include "components/sessions/content/session_tab_helper.h"
#include "content/public/browser/media_session.h"
#include "media/base/media_switches.h"
#include "ui/color/color_id.h"

namespace {

void UpdateMediaSessionItemReceiverName(
    base::WeakPtr<media_message_center::MediaNotificationItem> item,
    const std::optional<media_router::MediaRoute>& route) {
  if (item->GetSourceType() ==
      media_message_center::SourceType::kLocalMediaSession) {
    auto* media_session_item =
        static_cast<global_media_controls::MediaSessionNotificationItem*>(
            item.get());
    if (route.has_value()) {
      media_session_item->UpdateDeviceName(route->media_sink_name());
    } else {
      media_session_item->UpdateDeviceName(std::nullopt);
    }
  }
}

}  // namespace

HostAndClientPair::HostAndClientPair() = default;
HostAndClientPair::HostAndClientPair(HostAndClientPair&&) = default;
HostAndClientPair& HostAndClientPair::operator=(HostAndClientPair&&) = default;
HostAndClientPair::~HostAndClientPair() = default;

bool ShouldShowDeviceSelectorView(
    Profile* profile,
    global_media_controls::mojom::DeviceService* device_service,
    const std::string& item_id,
    const base::WeakPtr<media_message_center::MediaNotificationItem>& item,
    MediaItemUIDeviceSelectorDelegate* selector_delegate) {
  if (!device_service || !selector_delegate || !profile || !item ||
      !media_router::MediaRouterEnabled(profile)) {
    return false;
  }

  auto source_type = item->GetSourceType();
  if (source_type == media_message_center::SourceType::kCast) {
    return false;
  }
  // Hide device selector view if the local media session has started Remote
  // Playback or Tab Mirroring.
  if (source_type == media_message_center::SourceType::kLocalMediaSession &&
      GetSessionRoute(item_id, item, profile).has_value()) {
    return false;
  }
  return true;
}

HostAndClientPair CreateHostAndClient(
    Profile* profile,
    const std::string& id,
    const base::WeakPtr<media_message_center::MediaNotificationItem>& item,
    global_media_controls::mojom::DeviceService* device_service) {
  mojo::PendingRemote<global_media_controls::mojom::DeviceListHost> host;
  mojo::PendingRemote<global_media_controls::mojom::DeviceListClient> client;
  auto client_receiver = client.InitWithNewPipeAndPassReceiver();
  if (item->GetSourceType() ==
      media_message_center::SourceType::kLocalMediaSession) {
    device_service->GetDeviceListHostForSession(
        id, host.InitWithNewPipeAndPassReceiver(), std::move(client));
  } else {
    device_service->GetDeviceListHostForPresentation(
        host.InitWithNewPipeAndPassReceiver(), std::move(client));
  }
  HostAndClientPair host_and_client;
  host_and_client.host = std::move(host);
  host_and_client.client = std::move(client_receiver);

  return host_and_client;
}

base::RepeatingClosure GetStopCastingCallback(
    Profile* profile,
    const std::string& id,
    const base::WeakPtr<media_message_center::MediaNotificationItem>& item) {
  base::RepeatingClosure stop_casting_callback;

  // Show a footer view for a local media item when it has an associated Remote
  // Playback session or a Tab Mirroring Session.
  if (item->GetSourceType() !=
      media_message_center::SourceType::kLocalMediaSession) {
    return stop_casting_callback;
  }
  auto route = GetSessionRoute(id, item, profile);
  UpdateMediaSessionItemReceiverName(item, route);
  if (!route.has_value()) {
    return stop_casting_callback;
  }

  const auto& route_id = route->media_route_id();
  auto cast_mode = HasRemotePlaybackRoute(item)
                       ? media_router::MediaCastMode::REMOTE_PLAYBACK
                       : media_router::MediaCastMode::TAB_MIRROR;

  stop_casting_callback = base::BindRepeating(
      [](const std::string& route_id, media_router::MediaRouter* router,
         media_router::MediaCastMode cast_mode) {
        router->TerminateRoute(route_id);
        MediaItemUIMetrics::RecordStopCastingMetrics(cast_mode);
        if (cast_mode == media_router::MediaCastMode::TAB_MIRROR) {
          MediaDialogView::HideDialog();
        }
      },
      route_id,
      media_router::MediaRouterFactory::GetApiForBrowserContext(profile),
      cast_mode);
  return stop_casting_callback;
}

bool HasRemotePlaybackRoute(
    base::WeakPtr<media_message_center::MediaNotificationItem> item) {
  if (base::FeatureList::IsEnabled(media::kMediaRemotingWithoutFullscreen) &&
      item &&
      item->GetSourceType() ==
          media_message_center::SourceType::kLocalMediaSession) {
    const auto* media_session_item =
        static_cast<global_media_controls::MediaSessionNotificationItem*>(
            item.get());
    return media_session_item->GetRemotePlaybackMetadata() &&
           media_session_item->GetRemotePlaybackMetadata()
               ->remote_playback_started;
  }
  return false;
}

std::optional<media_router::MediaRoute> GetSessionRoute(
    const std::string& item_id,
    base::WeakPtr<media_message_center::MediaNotificationItem> item,
    content::BrowserContext* context) {
  if (!media_router::MediaRouterEnabled(context)) {
    return std::nullopt;
  }

  // Return std::nullopt if the item is not a local media session.
  if (!item || item->GetSourceType() !=
                   media_message_center::SourceType::kLocalMediaSession) {
    return std::nullopt;
  }

  // Return std::nullopt if fallback to tab mirroring is disabled, and
  // media session doesn't have an associated Remote Playback route.
  if (!base::FeatureList::IsEnabled(
          media_router::kFallbackToAudioTabMirroring) &&
      !HasRemotePlaybackRoute(item)) {
    return std::nullopt;
  }

  auto* web_contents =
      content::MediaSession::GetWebContentsFromRequestId(item_id);
  if (!web_contents) {
    return std::nullopt;
  }

  const int item_tab_id =
      sessions::SessionTabHelper::IdForTab(web_contents).id();
  for (const auto& route :
       media_router::MediaRouterFactory::GetApiForBrowserContext(context)
           ->GetCurrentRoutes()) {
    media_router::MediaSource media_source = route.media_source();
    std::optional<int> tab_id_from_route_id;
    if (media_source.IsRemotePlaybackSource()) {
      tab_id_from_route_id = media_source.TabIdFromRemotePlaybackSource();
    } else if (media_source.IsTabMirroringSource()) {
      tab_id_from_route_id = media_source.TabId();
    }

    if (tab_id_from_route_id.has_value() &&
        tab_id_from_route_id.value() == item_tab_id) {
      return route;
    }
  }

  return std::nullopt;
}

std::unique_ptr<global_media_controls::MediaItemUIDeviceSelector>
BuildDeviceSelector(
    const std::string& id,
    base::WeakPtr<media_message_center::MediaNotificationItem> item,
    global_media_controls::mojom::DeviceService* device_service,
    MediaItemUIDeviceSelectorDelegate* selector_delegate,
    Profile* profile,
    global_media_controls::GlobalMediaControlsEntryPoint entry_point,
    bool show_devices,
    std::optional<media_message_center::MediaColorTheme> media_color_theme) {
  if (!ShouldShowDeviceSelectorView(profile, device_service, id, item,
                                    selector_delegate)) {
    return nullptr;
  }

  auto device_set = CreateHostAndClient(profile, id, item, device_service);

#if !BUILDFLAG(IS_CHROMEOS)
  if (media_color_theme.has_value()) {
    return std::make_unique<CastDeviceSelectorView>(
        std::move(device_set.host), std::move(device_set.client),
        media_color_theme.value(), show_devices);
  }
#endif

  const bool is_local_media_session =
      item->GetSourceType() ==
      media_message_center::SourceType::kLocalMediaSession;

  return std::make_unique<MediaItemUIDeviceSelectorView>(
      id, selector_delegate, std::move(device_set.host),
      std::move(device_set.client),
      /*has_audio_output=*/is_local_media_session, entry_point, show_devices,
      media_color_theme);
}

std::unique_ptr<global_media_controls::MediaItemUIFooter> BuildFooter(
    const std::string& id,
    base::WeakPtr<media_message_center::MediaNotificationItem> item,
    Profile* profile,
    std::optional<media_message_center::MediaColorTheme> media_color_theme) {
  // Show a footer view for a Cast item.
  if (item->GetSourceType() == media_message_center::SourceType::kCast) {
    auto media_cast_item =
        static_cast<CastMediaNotificationItem*>(item.get())->GetWeakPtr();
#if BUILDFLAG(IS_CHROMEOS)
    if (media_color_theme.has_value()) {
      return std::make_unique<MediaItemUICastFooterView>(
          base::BindRepeating(&CastMediaNotificationItem::StopCasting,
                              media_cast_item),
          media_color_theme.value());
    }
#else
    if (media_color_theme.has_value()) {
      return std::make_unique<CastDeviceFooterView>(
          media_cast_item->device_name(),
          base::BindRepeating(&CastMediaNotificationItem::StopCasting,
                              media_cast_item),
          media_color_theme.value());
    }
#endif

    return std::make_unique<MediaItemUILegacyCastFooterView>(
        base::BindRepeating(&CastMediaNotificationItem::StopCasting,
                            media_cast_item));
  }

  base::RepeatingClosure stop_casting_cb =
      GetStopCastingCallback(profile, id, item);
  if (stop_casting_cb.is_null()) {
    return nullptr;
  }

#if !BUILDFLAG(IS_CHROMEOS)
  if (media_color_theme.has_value()) {
    auto* media_session_item =
        static_cast<global_media_controls::MediaSessionNotificationItem*>(
            item.get());
    return std::make_unique<CastDeviceFooterView>(
        media_session_item->device_name(), std::move(stop_casting_cb),
        media_color_theme.value());
  }
#endif

  return std::make_unique<MediaItemUILegacyCastFooterView>(
      std::move(stop_casting_cb));
}

media_message_center::MediaColorTheme GetMediaColorTheme() {
  media_message_center::MediaColorTheme theme;
  theme.primary_foreground_color_id = ui::kColorSysOnSurface;
  theme.secondary_foreground_color_id = ui::kColorSysOnSurfaceSubtle;

  // Colors for the play/pause button.
  theme.play_button_foreground_color_id = ui::kColorSysOnPrimary;
  theme.play_button_container_color_id = ui::kColorSysPrimary;
  theme.pause_button_foreground_color_id = ui::kColorSysOnTonalContainer;
  theme.pause_button_container_color_id = ui::kColorSysTonalContainer;

  // Colors for the progress view.
  theme.playing_progress_foreground_color_id = ui::kColorSysPrimary;
  theme.playing_progress_background_color_id =
      ui::kColorSysStateDisabledContainer;
  theme.paused_progress_foreground_color_id =
      ui::kColorSysStateDisabledContainer;
  theme.paused_progress_background_color_id =
      ui::kColorSysStateDisabledContainer;

  theme.background_color_id = ui::kColorSysSurface2;
  theme.device_selector_border_color_id = ui::kColorSysDivider;
  theme.device_selector_foreground_color_id = ui::kColorSysPrimary;
  theme.device_selector_background_color_id = ui::kColorSysSurface5;
  theme.error_foreground_color_id = ui::kColorSysError;
  theme.error_container_color_id = ui::kColorSysErrorContainer;
  theme.focus_ring_color_id = ui::kColorSysStateFocusRing;
  return theme;
}

const gfx::VectorIcon& GetVectorIcon(
    global_media_controls::mojom::IconType icon) {
  switch (icon) {
    case global_media_controls::mojom::IconType::kInfo:
      return kInfoIcon;
    case global_media_controls::mojom::IconType::kSpeaker:
      return kSpeakerIcon;
    case global_media_controls::mojom::IconType::kSpeakerGroup:
      return kSpeakerGroupIcon;
    case global_media_controls::mojom::IconType::kInput:
      return kInputIcon;
    case global_media_controls::mojom::IconType::kThrobber:
    case global_media_controls::mojom::IconType::kTv:
    case global_media_controls::mojom::IconType::kUnknown:
      return kTvIcon;
  }
}