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
|
// 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.
#ifndef ASH_CAPTURE_MODE_CAPTURE_MODE_BEHAVIOR_H_
#define ASH_CAPTURE_MODE_CAPTURE_MODE_BEHAVIOR_H_
#include <optional>
#include <vector>
#include "ash/capture_mode/capture_mode_types.h"
#include "base/files/file_path.h"
#include "base/functional/callback_forward.h"
#include "base/functional/callback_helpers.h"
#include "ui/message_center/public/cpp/notification.h"
namespace aura {
class Window;
} // namespace aura
namespace gfx {
class Rect;
} // namespace gfx
namespace ash {
class CaptureModeBarView;
// Contains the cached capture mode configurations that will be used for
// configurations restoration when initiating the corresponding capture mode
// session.
struct CaptureModeSessionConfigs {
CaptureModeType type;
CaptureModeSource source;
RecordingType recording_type;
AudioRecordingMode audio_recording_mode;
bool demo_tools_enabled;
};
// Defines the interface for the capture mode behavior which will be implemented
// by `DefaultBehavior` and `ProjectorBehavior`. The `CaptureModeController`
// owns the instance of this interface.
class CaptureModeBehavior {
public:
CaptureModeBehavior(const CaptureModeBehavior&) = delete;
CaptureModeBehavior& operator=(const CaptureModeBehavior&) = delete;
virtual ~CaptureModeBehavior();
// Creates an instance of the `CaptureModeBehavior` given the `behavior_type`.
static std::unique_ptr<CaptureModeBehavior> Create(
BehaviorType behavior_type);
const CaptureModeSessionConfigs& capture_mode_configs() const {
return capture_mode_configs_;
}
BehaviorType behavior_type() const { return behavior_type_; }
// Called when this behavior becomes the active behavior of a newly created
// capture session. Sub classes can choose to do any specific session
// initialization that they need.
virtual void AttachToSession();
// Called when this behavior is no longer attached to an active capture mode
// session, i.e. when its capture session ends and recording will not start,
// or when its session ends to start recording right after recording begins.
virtual void DetachFromSession();
// Returns true if the behavior supports paint capture region overlay. Note
// this differs from `CanPaintRegionOverlay()` which checks if the behavior
// can *currently* paint region overlay.
virtual bool ShouldRegionOverlayBeAllowed() const;
// Returns true if the behavior can currently paint capture region overlay.
// Note that this can change dynamically throughout the lifetime of this
// behavior.
virtual bool CanPaintRegionOverlay() const;
// Returns true if the behavior should show a glow animation while processing
// for the specified `capture_type`.
virtual bool ShouldShowGlowWhileProcessingCaptureType(
PerformCaptureType capture_type) const;
virtual bool ShouldImageCaptureTypeBeAllowed() const;
virtual bool ShouldVideoCaptureTypeBeAllowed() const;
virtual bool ShouldFulscreenCaptureSourceBeAllowed() const;
virtual bool ShouldRegionCaptureSourceBeAllowed() const;
virtual bool ShouldWindowCaptureSourceBeAllowed() const;
// Returns true if the given `mode` is supported by this behavior.
virtual bool SupportsAudioRecordingMode(AudioRecordingMode mode) const;
virtual bool ShouldCameraSelectionSettingsBeIncluded() const;
virtual bool ShouldDemoToolsSettingsBeIncluded() const;
virtual bool ShouldSaveToSettingsBeIncluded() const;
virtual bool ShouldGifBeSupported() const;
virtual bool ShouldShowPreviewNotification() const;
virtual bool ShouldSkipVideoRecordingCountDown() const;
virtual bool ShouldCreateAnnotationsOverlayController() const;
virtual bool ShouldShowUserNudge() const;
virtual bool ShouldAutoSelectFirstCamera() const;
virtual bool RequiresCaptureFolderCreation() const;
// Returns true if the behavior should re-show after hiding of all the capture
// mode UIs while waiting for DLP confirmation.
virtual bool ShouldReShowUisAtPerformingCapture(
PerformCaptureType capture_type) const;
// Returns true if the behavior should show default action buttons such as
// search, copy text and smart actions in the action container IF the action
// container is shown.
virtual bool ShouldShowDefaultActionButtonsInActionContainer() const;
// Returns true if the behavior can show action buttons at all.
// TODO(b/377570562): Consolidate these APIs.
virtual bool CanShowActionButtons() const;
virtual bool ShouldPaintSunfishCaptureRegion() const;
virtual bool ShouldShowCaptureButtonAfterRegionSelected() const;
virtual bool ShouldEndSessionOnShowingSearchResults() const;
virtual bool ShouldEndSessionOnSearchResultClicked() const;
// Returns true if a disclaimer dialog needs to be shown when a capture mode
// session is initialized with this behavior.
virtual bool NeedsDisclaimerOnInit() const;
virtual bool ShouldAnnounceCaptureModeUIOnDisclaimerDismissed() const;
// Returns the full path for the capture file. If the creation of the path
// failed, the path provided will be empty.
using OnCaptureFolderCreatedCallback =
base::OnceCallback<void(const base::FilePath& capture_file_full_path)>;
virtual void CreateCaptureFolder(OnCaptureFolderCreatedCallback callback);
virtual std::vector<RecordingType> GetSupportedRecordingTypes() const;
virtual void SetPreSelectedWindow(aura::Window* pre_selected_window);
// Returns the client specific string component to be inserted to a histogram
// in order to differentiate the metrics for example "Projector." is used to
// indicate the histogram is for a projector-initiated capture mode session.
virtual const char* GetClientMetricComponent() const;
// Returns the client specific buttons info to be shown in the notification
// view. The buttons info list may differ based on whether `for_video` is true
// or not.
virtual std::vector<message_center::ButtonInfo> GetNotificationButtonsInfo(
bool for_video) const;
// Returns the text to be shown by the capture label during waiting to select
// a capture region phase.
virtual const std::u16string GetCaptureLabelRegionText() const;
// Returns the title to use for the action button container window. This will
// be announced by a screen reader when the user navigates to the action
// button container.
virtual const std::u16string GetActionButtonContainerTitle() const;
// Returns the title to use for the capture mode bar window. This will be
// announced by a screen reader when the user navigates to the capture mode
// bar.
virtual const std::u16string GetCaptureModeBarTitle() const;
// Returns the text to be announced by a screen reader when capture mode is
// opened with this behavior.
virtual const std::string GetCaptureModeOpenAnnouncement() const;
// Creates the capture mode bar view, which might look different depending on
// the actual type of the behavior.
virtual std::unique_ptr<CaptureModeBarView> CreateCaptureModeBarView();
// Gets the bounds in screen coordinates of the capture bar in the given
// `root` window. The returned bounds of the bar will vary depending on the
// actual type of the behavior.
gfx::Rect GetCaptureBarBounds(aura::Window* root) const;
// Notifies the behavior on audio recording mode settings change and the
// behavior will decide whether to remember the audio recording mode settings
// for future sessions settings restoration or not.
virtual void OnAudioRecordingModeChanged();
// Notifies the behavior on demo tools settings change and the behavior will
// decide whether to remember the demo tools settings for future sessions
// settings restoration or not.
virtual void OnDemoToolsSettingsChanged();
// Notifies the behavior that a region was selected or adjusted when the
// action container is showing. By default this will do nothing, but should be
// overridden to add buttons to the action container when needed.
virtual void OnRegionSelectedOrAdjustedWhenActionContainerShowing();
// Called when the `Enter` key is pressed. By default this will perform image
// capture.
virtual void OnEnterKeyPressed();
protected:
CaptureModeBehavior(const CaptureModeSessionConfigs& configs,
const BehaviorType behavior_type);
// Returns the anchor bounds of the bar in screen coordinates, which depends
// on the anchor window of the bar. The anchor window can be the given `root`
// window or the selected window depending on the actual type of the behavior.
// And we will exclude the shelf/hotseat if the bar is anchored to the root
// window when necessary.
virtual gfx::Rect GetBarAnchorBoundsInScreen(aura::Window* root) const;
// Called by `GetCaptureBarBounds` to adjust the bottom padding and the width
// of the bar on the actual type of the behavior.
virtual int GetCaptureBarBottomPadding() const;
virtual int GetCaptureBarWidth() const;
// Capture mode session configs to be used for the current capture mode
// session.
CaptureModeSessionConfigs capture_mode_configs_;
// Can be used to cache the old capture mode session configs before this
// behavior is attached to a new session.
std::optional<CaptureModeSessionConfigs> cached_configs_;
private:
const BehaviorType behavior_type_;
};
} // namespace ash
#endif // ASH_CAPTURE_MODE_CAPTURE_MODE_BEHAVIOR_H_
|
