File: web_contents_capture_client.h

package info (click to toggle)
chromium 139.0.7258.127-1
  • links: PTS, VCS
  • area: main
  • in suites:
  • size: 6,122,068 kB
  • sloc: cpp: 35,100,771; ansic: 7,163,530; javascript: 4,103,002; python: 1,436,920; asm: 946,517; xml: 746,709; pascal: 187,653; perl: 88,691; sh: 88,436; objc: 79,953; sql: 51,488; cs: 44,583; fortran: 24,137; makefile: 22,147; tcl: 15,277; php: 13,980; yacc: 8,984; ruby: 7,485; awk: 3,720; lisp: 3,096; lex: 1,327; ada: 727; jsp: 228; sed: 36
file content (73 lines) | stat: -rw-r--r-- 2,282 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
// Copyright 2013 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef EXTENSIONS_BROWSER_API_WEB_CONTENTS_CAPTURE_CLIENT_H_
#define EXTENSIONS_BROWSER_API_WEB_CONTENTS_CAPTURE_CLIENT_H_

#include <optional>
#include <string>

#include "extensions/browser/extension_function.h"
#include "extensions/common/api/extension_types.h"

class SkBitmap;

namespace content {
class WebContents;
}

namespace extensions {

// Base class for capturing visible area of a WebContents.
// This is used by both webview.captureVisibleRegion and tabs.captureVisibleTab.
class WebContentsCaptureClient {
 public:
  WebContentsCaptureClient() = default;

  WebContentsCaptureClient(const WebContentsCaptureClient&) = delete;
  WebContentsCaptureClient& operator=(const WebContentsCaptureClient&) = delete;

 protected:
  virtual ~WebContentsCaptureClient() {}

  enum class ScreenshotAccess {
    kEnabled,
    kDisabledByPreferences,
    kDisabledByDlp,
  };
  virtual ScreenshotAccess GetScreenshotAccess(
      content::WebContents* web_contents) const = 0;
  virtual bool ClientAllowsTransparency() = 0;

  enum CaptureResult {
    OK,
    FAILURE_REASON_READBACK_FAILED,
    FAILURE_REASON_ENCODING_FAILED,
    FAILURE_REASON_SCREEN_SHOTS_DISABLED,
    FAILURE_REASON_SCREEN_SHOTS_DISABLED_BY_DLP,
    FAILURE_REASON_VIEW_INVISIBLE,
  };
  CaptureResult CaptureAsync(
      content::WebContents* web_contents,
      const api::extension_types::ImageDetails* image_detail,
      base::OnceCallback<void(const SkBitmap&)> callback);
  virtual void OnCaptureFailure(CaptureResult result) = 0;
  virtual void OnCaptureSuccess(const SkBitmap& bitmap) = 0;
  void CopyFromSurfaceComplete(const SkBitmap& bitmap);

  // Encodes `bitmap`, and returns a base-64 encoded string if successful.
  // Returns nullopt if not successful.
  std::optional<std::string> EncodeBitmap(const SkBitmap& bitmap);

 private:
  // The format (JPEG vs PNG) of the resulting image.  Set in RunAsync().
  api::extension_types::ImageFormat image_format_;

  // Quality setting to use when encoding jpegs.  Set in RunAsync().
  int image_quality_;
};

}  // namespace extensions

#endif  // EXTENSIONS_BROWSER_API_WEB_CONTENTS_CAPTURE_CLIENT_H_