// Copyright 2013 The Flutter Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef FLUTTER_SHELL_PLATFORM_ANDROID_ANDROID_RENDERING_SELECTOR_H_
#define FLUTTER_SHELL_PLATFORM_ANDROID_ANDROID_RENDERING_SELECTOR_H_

#include <string>

namespace flutter {

/**
 * @brief A combination of targeted graphics API and Impeller support for
 * Android.
 */
enum class AndroidRenderingAPI {
  /**
   * @brief Software rendering backend for Skia.
   *
   * This rendering API is deprecated, and there is no replacement for Impeller.
   * @deprecated
   */
  kSkiaSoftware [[deprecated]],

  /**
   * @brief OpenGLES rendering backend for Skia.
   *
   * This rendering API is deprecated; an Impeller-based backend is used by
   * default unless opted-out manually (either using `flutter run
   * --no-enable-impeller` or `AndroidManifest.xml`).
   *
   * @see https://docs.flutter.dev/perf/impeller#android
   * @deprecated
   */
  kSkiaOpenGLES [[deprecated]],

  /**
   * @brief Vulkan rendering backend for Impeller.
   *
   * This API should be used if:
   * - The current Android API level is at least 29+;
   * - Not running on a known emulator (there are performance problems);
   * - Not running on a known bad SoC (Vulkan is not working or working
   * properly);
   * - A Vulkan context can be successfully created.
   *
   * Or, if the requested rendering backend is explicitly Vulkan (a debug
   * and profile-mode only feature for testing and debugging) by editing
   * `AndroidManifest.xml`:
   * `<meta-data android:name="io.flutter.embedding.android.ImpellerBackend"
   * android:value="vulkan />`
   */
  kImpellerVulkan,

  /**
   * @brief OpenGLES rendering backend for Impeller.
   *
   * This API is used as a fallback when `kImpellerVulkan` cannot be used or if
   * the requested rendering backend is explicitly OpenGLES (a debug and
   * profile-mode only feature for testing and debugging) by editing
   * `AndroidManifest.xml`:
   * `<meta-data android:name="io.flutter.embedding.android.ImpellerBackend"
   * android:value="opengles />`
   */
  kImpellerOpenGLES,
};

/**
 * @brief Used by `AndroidRenderingAPI` to determine an appropriate rendering
 * API.
 *
 * There are two ways to use this struct:
 * 1. Create it with user-defined state (i.e., for testing or to adapt another
 * source).
 * 2. Use `fromNdk`, to extract the current state from the current Android
 * device's NDK.
 */
struct AndroidDeviceState {
  /**
   * @brief The API level of the Android device.
   */
  int apiLevel;

  /**
   * @brief The product model of the Android device.
   */
  std::string_view productModel;

  /**
   * @brief The System on a Chip (SOC) board of the Android device.
   */
  std::string_view productSocBoard;

  /**
   * @brief Extracts the Android device state from the NDK.
   *
   * @return An initialized AndroidDeviceState struct.
   */
  static AndroidDeviceState fromNdk();
};

/**
 * @brief Determines which `AndroidRenderingAPI` to use, based on a variety of
 * factors.
 */
class AndroidRenderingSelector {
 public:
  ~AndroidRenderingSelector();

  AndroidRenderingAPI select(AndroidDeviceState options);

 private:
  AndroidRenderingSelector(const AndroidRenderingSelector&) = delete;
  AndroidRenderingSelector& operator=(const AndroidRenderingSelector&) = delete;
};

}  // namespace flutter

#endif  // FLUTTER_SHELL_PLATFORM_ANDROID_ANDROID_RENDERING_SELECTOR_H_