// Copyright (c) 2012 The Chromium 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 ANGLE_GPU_CONFIG_GPU_INFO_H_
#define ANGLE_GPU_CONFIG_GPU_INFO_H_

// Provides access to the GPU information for the system
// on which chrome is currently running.

#include <stdint.h>

#include <string>
#include <vector>

#include "angle_config.h"

#if defined(USE_X11)
typedef unsigned long VisualID;
#endif

namespace gpu
{

// Result for the various Collect*Info* functions below.
// Fatal failures are for cases where we can't create a context at all or
// something, making the use of the GPU impossible.
// Non-fatal failures are for cases where we could gather most info, but maybe
// some is missing (e.g. unable to parse a version string or to detect the exact
// model).
enum CollectInfoResult
{
    kCollectInfoNone            = 0,
    kCollectInfoSuccess         = 1,
    kCollectInfoNonFatalFailure = 2,
    kCollectInfoFatalFailure    = 3
};

// Video profile.  This *must* match media::VideoCodecProfile.
enum VideoCodecProfile
{
    VIDEO_CODEC_PROFILE_UNKNOWN = -1,
    VIDEO_CODEC_PROFILE_MIN     = VIDEO_CODEC_PROFILE_UNKNOWN,
    H264PROFILE_BASELINE        = 0,
    H264PROFILE_MAIN,
    H264PROFILE_EXTENDED,
    H264PROFILE_HIGH,
    H264PROFILE_HIGH10PROFILE,
    H264PROFILE_HIGH422PROFILE,
    H264PROFILE_HIGH444PREDICTIVEPROFILE,
    H264PROFILE_SCALABLEBASELINE,
    H264PROFILE_SCALABLEHIGH,
    H264PROFILE_STEREOHIGH,
    H264PROFILE_MULTIVIEWHIGH,
    VP8PROFILE_ANY,
    VP9PROFILE_PROFILE0,
    VP9PROFILE_PROFILE1,
    VP9PROFILE_PROFILE2,
    VP9PROFILE_PROFILE3,
    HEVCPROFILE_MAIN,
    HEVCPROFILE_MAIN10,
    HEVCPROFILE_MAIN_STILL_PICTURE,
    DOLBYVISION_PROFILE0,
    DOLBYVISION_PROFILE4,
    DOLBYVISION_PROFILE5,
    DOLBYVISION_PROFILE7,
    THEORAPROFILE_ANY,
    VIDEO_CODEC_PROFILE_MAX = THEORAPROFILE_ANY,
};

// Specification of a decoding profile supported by a hardware decoder.
struct GPU_EXPORT VideoDecodeAcceleratorSupportedProfile
{
    VideoCodecProfile profile;
    gfx::Size max_resolution;
    gfx::Size min_resolution;
    bool encrypted_only;
};

using VideoDecodeAcceleratorSupportedProfiles = std::vector<VideoDecodeAcceleratorSupportedProfile>;

struct GPU_EXPORT VideoDecodeAcceleratorCapabilities
{
    VideoDecodeAcceleratorCapabilities();
    VideoDecodeAcceleratorCapabilities(const VideoDecodeAcceleratorCapabilities &other);
    ~VideoDecodeAcceleratorCapabilities();
    VideoDecodeAcceleratorSupportedProfiles supported_profiles;
    uint32_t flags;
};

// Specification of an encoding profile supported by a hardware encoder.
struct GPU_EXPORT VideoEncodeAcceleratorSupportedProfile
{
    VideoCodecProfile profile;
    gfx::Size max_resolution;
    uint32_t max_framerate_numerator;
    uint32_t max_framerate_denominator;
};
using VideoEncodeAcceleratorSupportedProfiles = std::vector<VideoEncodeAcceleratorSupportedProfile>;

struct GPU_EXPORT GPUInfo
{
    struct GPU_EXPORT GPUDevice
    {
        GPUDevice();
        ~GPUDevice();

        // The DWORD (uint32_t) representing the graphics card vendor id.
        uint32_t vendor_id;

        // The DWORD (uint32_t) representing the graphics card device id.
        // Device ids are unique to vendor, not to one another.
        uint32_t device_id;

        // Whether this GPU is the currently used one.
        // Currently this field is only supported and meaningful on OS X.
        bool active;

        // The strings that describe the GPU.
        // In Linux these strings are obtained through libpci.
        // In Win/MacOSX, these two strings are not filled at the moment.
        // In Android, these are respectively GL_VENDOR and GL_RENDERER.
        std::string vendor_string;
        std::string device_string;
    };

    GPUInfo();
    GPUInfo(const GPUInfo &other);
    ~GPUInfo();

    // The amount of time taken to get from the process starting to the message
    // loop being pumped.
    base::TimeDelta initialization_time;

    // Computer has NVIDIA Optimus
    bool optimus;

    // Computer has AMD Dynamic Switchable Graphics
    bool amd_switchable;

    // Primary GPU, for exmaple, the discrete GPU in a dual GPU machine.
    GPUDevice gpu;

    // Secondary GPUs, for example, the integrated GPU in a dual GPU machine.
    std::vector<GPUDevice> secondary_gpus;

    // The currently active gpu.
    const GPUDevice &active_gpu() const;

    // The vendor of the graphics driver currently installed.
    std::string driver_vendor;

    // The version of the graphics driver currently installed.
    std::string driver_version;

    // The date of the graphics driver currently installed.
    std::string driver_date;

    // The version of the pixel/fragment shader used by the gpu.
    std::string pixel_shader_version;

    // The version of the vertex shader used by the gpu.
    std::string vertex_shader_version;

    // The maximum multisapling sample count, either through ES3 or
    // EXT_multisampled_render_to_texture MSAA.
    std::string max_msaa_samples;

    // The machine model identifier. They can contain any character, including
    // whitespaces.  Currently it is supported on MacOSX and Android.
    // Android examples: "Naxus 5", "XT1032".
    // On MacOSX, the version is stripped out of the model identifier, for
    // example, the original identifier is "MacBookPro7,2", and we put
    // "MacBookPro" as machine_model_name, and "7.2" as machine_model_version.
    std::string machine_model_name;

    // The version of the machine model. Currently it is supported on MacOSX.
    // See machine_model_name's comment.
    std::string machine_model_version;

    // The GL_VERSION string.
    std::string gl_version;

    // The GL_VENDOR string.
    std::string gl_vendor;

    // The GL_RENDERER string.
    std::string gl_renderer;

    // The GL_EXTENSIONS string.
    std::string gl_extensions;

    // GL window system binding vendor.  "" if not available.
    std::string gl_ws_vendor;

    // GL window system binding version.  "" if not available.
    std::string gl_ws_version;

    // GL window system binding extensions.  "" if not available.
    std::string gl_ws_extensions;

    // GL reset notification strategy as defined by GL_ARB_robustness. 0 if GPU
    // reset detection or notification not available.
    uint32_t gl_reset_notification_strategy;

    bool software_rendering;

    // Whether the driver uses direct rendering. True on most platforms, false on
    // X11 when using remote X.
    bool direct_rendering;

    // Whether the gpu process is running in a sandbox.
    bool sandboxed;

    // Number of GPU process crashes recorded.
    int process_crash_count;

    // True if the GPU is running in the browser process instead of its own.
    bool in_process_gpu;

    // True if the GPU process is using the passthrough command decoder.
    bool passthrough_cmd_decoder;

    // True if the current set of outputs supports overlays.
    bool supports_overlays = false;

    // True only on android when extensions for threaded mailbox sharing are
    // present. Threaded mailbox sharing is used on Android only, so this check
    // is only implemented on Android.
    bool can_support_threaded_texture_mailbox = false;

    // The state of whether the basic/context/DxDiagnostics info is collected and
    // if the collection fails or not.
    CollectInfoResult basic_info_state;
    CollectInfoResult context_info_state;
#if defined(OS_WIN)
    CollectInfoResult dx_diagnostics_info_state;

    // The information returned by the DirectX Diagnostics Tool.
    DxDiagNode dx_diagnostics;
#endif

    VideoDecodeAcceleratorCapabilities video_decode_accelerator_capabilities;
    VideoEncodeAcceleratorSupportedProfiles video_encode_accelerator_supported_profiles;
    bool jpeg_decode_accelerator_supported;

#if defined(USE_X11)
    VisualID system_visual;
    VisualID rgba_visual;
#endif

    // Note: when adding new members, please remember to update EnumerateFields
    // in gpu_info.cc.

    // In conjunction with EnumerateFields, this allows the embedder to
    // enumerate the values in this structure without having to embed
    // references to its specific member variables. This simplifies the
    // addition of new fields to this type.
    class Enumerator
    {
      public:
        // The following methods apply to the "current" object. Initially this
        // is the root object, but calls to BeginGPUDevice/EndGPUDevice and
        // BeginAuxAttributes/EndAuxAttributes change the object to which these
        // calls should apply.
        virtual void AddInt64(const char *name, int64_t value)                              = 0;
        virtual void AddInt(const char *name, int value)                                    = 0;
        virtual void AddString(const char *name, const std::string &value)                  = 0;
        virtual void AddBool(const char *name, bool value)                                  = 0;
        virtual void AddTimeDeltaInSecondsF(const char *name, const base::TimeDelta &value) = 0;

        // Markers indicating that a GPUDevice is being described.
        virtual void BeginGPUDevice() = 0;
        virtual void EndGPUDevice()   = 0;

        // Markers indicating that a VideoDecodeAcceleratorSupportedProfile is
        // being described.
        virtual void BeginVideoDecodeAcceleratorSupportedProfile() = 0;
        virtual void EndVideoDecodeAcceleratorSupportedProfile()   = 0;

        // Markers indicating that a VideoEncodeAcceleratorSupportedProfile is
        // being described.
        virtual void BeginVideoEncodeAcceleratorSupportedProfile() = 0;
        virtual void EndVideoEncodeAcceleratorSupportedProfile()   = 0;

        // Markers indicating that "auxiliary" attributes of the GPUInfo
        // (according to the DevTools protocol) are being described.
        virtual void BeginAuxAttributes() = 0;
        virtual void EndAuxAttributes()   = 0;

      protected:
        virtual ~Enumerator() {}
    };

    // Outputs the fields in this structure to the provided enumerator.
    void EnumerateFields(Enumerator *enumerator) const;
};

}  // namespace gpu

#endif  // ANGLE_GPU_CONFIG_GPU_INFO_H_
