extensions/browser/api/web_contents_capture_client.h

// 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_